Ticket #8917 (closed: fixed)
Documentation maintenance
| Reported by: | Nick Draper | Owned by: | Karl Palmen |
|---|---|---|---|
| Priority: | major | Milestone: | Release 3.2 |
| Component: | Documentation | Keywords: | SSC,2014,All |
| Cc: | anders.markvardsen@… | Blocked By: | #9004, #9005, #9006, #9010, #9035, #9047, #9102, #9124, #9125, #9127, #9182, #9183, #9189, #9191, #9193, #9250, #9384, #9508 |
| Blocking: | #9274 | Tester: | Nick Draper |
Description (last modified by Karl Palmen) (diff)
- Parcel out algorithms - grade each one Good/OK/Inadequate/Missing.
- Then assign the ones that need tackling.
- Workflow algorithms need particular attention (flow charts).
- Amend wiki-maker to create new categories as sub-categories of algorithms. (postponed beyond release 3.2 awaiting completion of other wiki work)
- Ensure all info on wiki page is on offline docs & vice-versa.
- Additional pages in offline docs (beyond algorithms & functions).
- Open up wiki accounts or create them for scientists - encourage them to contribute to technique-specific pages, perhaps with designated POC for each.
- Documentation updates is part of the definition of done for a ticket.
- Clean up out of date pages.
- Have short/long description on properties, short for mouseover, long for docs
Attachments
Change History
comment:1 Changed 7 years ago by Nick Draper
- Cc anders.markvardsen@… added
- Owner set to Karl Palmen
- Description modified (diff)
comment:12 Changed 7 years ago by Karl Palmen
I've made a quick inspection of 629 algorithms and sorted out according to quality. I've added a cetagory of poorly formatted. The most common cause of poor formatting is indenting the wiki comment.
I've put the results into the attached file AlgorithmWikiQuality.txt file.
comment:14 Changed 7 years ago by Karl Palmen
I found no algorithm wiki pages of category workflow with a flowchart. I did find two flowcharts in the category (on non-algorithm pages).
http://www.mantidproject.org/IndirectEnergyConversion
http://www.mantidproject.org/SANS_Flow_Diagram
Their flowcharts are generated by different methods.
comment:17 Changed 7 years ago by Karl Palmen
There is now a flowchart at http://www.mantidproject.org/MuonLoad which is a model for the other flowcharts required.
I've also added http://www.mantidproject.org/Documenting_Workflow_Algorithms to explain about the creation of the flowchart and putting it into Mantid.
comment:23 Changed 7 years ago by Karl Palmen
I've found that the algorithms I had listed as having missing GUI are no longer available and have edited their wiki pages to indicate this.
comment:39 Changed 6 years ago by Karl Palmen
comment moved to #9508
comment:42 Changed 6 years ago by Karl Palmen
Blocking ticket #9128 has had its milestone changed to release 3.3 .
comment:45 Changed 6 years ago by Karl Palmen
comment:47 Changed 6 years ago by Karl Palmen
- Status changed from inprogress to verify
- Resolution set to fixed
To test, check that all issues are either fixed or handled by a ticket for release 3.3 .
comment:48 Changed 6 years ago by Nick Draper
- Status changed from verify to verifying
- Tester set to Nick Draper
comment:51 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 9760
Karl can you take a look at this ticket. You are likely to need to spawn off a smaller ticket for each item at least, but keep this one as an umbrella ticket, and enter blocked by values for each smaller ticket.
You might not be able to do all of it, but the first 3 need someone to search through and identify where the work needs to be done.