Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation maintenance #9760

Closed
18 tasks done
NickDraper opened this issue Feb 7, 2014 · 2 comments
Closed
18 tasks done

Documentation maintenance #9760

NickDraper opened this issue Feb 7, 2014 · 2 comments
Assignees
@KarlPalmen
Labels
Documentation Issues and pull requests related to documentation
Milestone
Release 3.2

Comments

@NickDraper
Copy link
Contributor

This ticket is blocked by :

This ticket is blocks : TRAC9274

  1. Parcel out algorithms - grade each one Good/OK/Inadequate/Missing.

  2. Then assign the ones that need tackling.

  3. Workflow algorithms need particular attention (flow charts).

  4. Amend wiki-maker to create new categories as sub-categories of algorithms. (postponed beyond release 3.2 awaiting completion of other wiki work)

  5. Ensure all info on wiki page is on offline docs & vice-versa.

  6. Additional pages in offline docs (beyond algorithms & functions).

  7. Open up wiki accounts or create them for scientists - encourage them to contribute to technique-specific pages, perhaps with designated POC for each.

  8. Documentation updates is part of the definition of done for a ticket.

  9. Clean up out of date pages.

  10. Have short/long description on properties, short for mouseover, long for docs

    Keywords: SSC,2014,All
@NickDraper
Copy link
Contributor Author

This issue was originally trac ticket 8917

@NickDraper
Copy link
Contributor Author

http://trac.mantidproject.org/mantid/raw-attachment/ticket/8917/AlgorithmWikiQuality.txt
(uploaded by @KarlPalmen on 2014-02-18T15:51:51)

@NickDraper NickDraper added Documentation Issues and pull requests related to documentation SSC labels Jun 3, 2015
@NickDraper NickDraper added this to the Release 3.2 milestone Jun 3, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@KarlPalmen KarlPalmen

Labels
Documentation Issues and pull requests related to documentation
Projects
None yet
Milestone
Release 3.2
Development

No branches or pull requests
2 participants
@NickDraper @KarlPalmen