Complete project documentation
Closed this issue · 0 comments
Is your feature request related to a problem? Please describe.
Project is not completely documentated both for the developer point of view and for the final user point of view. Policy document need to be updated with the relevant information. The instructions on how to complete a submission is not yet finished. Description like submission status and submission detail page are in the generic about document and maybe shuold be placed elsewhere. Sphinx documentation is not yet completed
Describe the solution you'd like
Documentation need to be completed (and revised). Maybe it need to be structered in arguments (something like having a doc describing what the different section does, a doc to describe the import step, a doc describing the aim, a doc with troubleshooting, ...) with links in order to browse in different sections. The sphinx developer documentation should be linked somewhere in the site or in GitHub readme
Describe alternatives you've considered
Sphinx documentation could be considered internal and not addressed to the user, its redaction can be delayed
Additional context
Here are points that should be addressed:
- Revise and agree on privacy policy document
- Describe the full submission steps
- Describe the main pages (views) of the site. Try to link each page to the appropriate help page
- Revise the whole documentation in browsable sections - side bar menu?
- Think about a FAQ page
- Complete the sphinx documentation
- An illustration picture for various docker images and how they interact with each other in the about page
- Similar to the status change, a diagram demonstrates the workflow of statuses would be useful
- Submission statuses and Submission details page documentation needs to be reviewed again as tool itself has not been finalized
- Celery and Redis perform long tasks, where long is confusing. Not time-consuming as monitoring statuses is quick but frequently. Probably background or monitoring?
- Validation, submission tasks are done by celery, review the text
- Your registration is almost done page: Could not find the source code Biosamples should be BioSamples. contact EBI => need to specify test aap server in the link and later change to production aap server
- Some screenshots may need to be redone. Remove tabs from browser, show only the page content
- Update the dashboard page description
- document ontology annotations in sphinx
- describe synonyms management in sphinx