Since we have many entry points we should review the current map of documentation and create a uniformed strategy for what goes where and for whom.
|Open||None||T2233 Update documentation to current project status|
|Work in Progress||moranegg||T2624 Create strategy for documentation with a map or a full table of content|
|Work in Progress||moranegg||T2894 Restructure deposit documentation with a clearer strategy|
|Open||moranegg||T3035 Triage documentation in wiki|
|Open||moranegg||T3154 proposal: sysadm docs: Move relevant and public doc from intranet to swh-docs|
|Work in Progress||None||T1556 Document hardware architecture|
|Open||None||T1557 Document Jenkins architecture|
|Work in Progress||moranegg||T3036 Create features/services page on the website connecting to archive/docs|
- tutorials: allow the newcomer to get started (see https://docs.divio.com/en/latest/introduction/#django-tab)
- how-to guides: show how to solve a specific problem (see https://documentation.divio.com/how-to-guides/)
- technical reference: describe the machinery (see https://docs.divio.com/en/latest/reference/divio-cli/)
- explanation (discussions/background): understanding oriented (clarifying with a wider view) (see
I'm going to open a task to try this approach with the deposit documentation.