This is being split into three issues. The requirements for this ticket are migrated to each individual ticket.
I have created the doc dir in the repo. Due to lack of time, use markdown for formatting. @rouilj will handle
translation to moinmoin if the team runs out of time. At least the markdown docs will be readable in github.
Assembling this will be on wiki.roundup-tracker.org.
---Create a doc subdirectory. Done by rouilj in 31ec006 and merged to main. ---
The goal of this is to have all the documentation that will be uploaded to https://wiki.roundup-tracker.org for the charting addon.
This will include:
Demonstration/explanation of what this addon does. (#79)
Include screenshots of:
index page
a couple of chart types showing what happens when you hover over a bar/wedge
directions for installing files on an existing tracker and additional python modules (e.g. pygal) (#80)
description of how to manipulate the URL to generate charts: (@charttype, @group, @template) (#81)
description of how to invoke it with examples: (#81)
adding an a tag to the issue.index.html file
adding the select dropdown and a button to invoke the chart
direct url manipulation
known outstanding bugs (e.g. boolean undefined values behave like boolean false in drilldown which is a known Roundup issue) (#81)
Add a starter document for each numbered document above and a screenshot using the tracker running from main.
Where possible pull information from existing sources.
Since this will be going onto a moinmoin wiki, the markup/formatting of existing documentation will have to change.
Fortunately, the existing docs use very simple markup. Read: http://moinmo.in/HelpOnMoinWikiSyntax
Modify the README.txt to redirect users to the doc directory for people using your addon. Explain that the rest of the readme is for people who are developing the addon. People using the addon don't need to load the tracker using load_tracker.py or used config.ini.sample as they will have a working tracker or be deploying using the standard Roundup directions.
Commit the started documents and other changes to the main branch because all of your teammates will have tasks
that target one of
This is being split into three issues. The requirements for this ticket are migrated to each individual ticket. I have created the doc dir in the repo. Due to lack of time, use markdown for formatting. @rouilj will handle translation to moinmoin if the team runs out of time. At least the markdown docs will be readable in github.
Assembling this will be on wiki.roundup-tracker.org.
---Create a doc subdirectory. Done by rouilj in 31ec006 and merged to main. ---
The goal of this is to have all the documentation that will be uploaded to https://wiki.roundup-tracker.org for the charting addon.
This will include:
atag to the issue.index.html fileAdd a starter document for each numbered document above and a screenshot using the tracker running from main. Where possible pull information from existing sources.
Since this will be going onto a moinmoin wiki, the markup/formatting of existing documentation will have to change. Fortunately, the existing docs use very simple markup. Read: http://moinmo.in/HelpOnMoinWikiSyntax
Modify the README.txt to redirect users to the doc directory for people using your addon. Explain that the rest of the readme is for people who are developing the addon. People using the addon don't need to load the tracker using load_tracker.py or used config.ini.sample as they will have a working tracker or be deploying using the standard Roundup directions.
Commit the started documents and other changes to the main branch because all of your teammates will have tasks that target one of