Draft: User documentation for the deposit service
related to swh-deposit#4655
Reasons for this MR:
- The deposits mechanisms are no longer be limited to the
swh-depositpackage (see swh-coarnotify), - The organization of the current swh-deposit documentation could be improved to match more closely the needs of our user and, most importantly, prospects
Key-points of this MR:
- make a new user oriented documentation for our deposit service (not a documentation on the swh-deposit software)
- following diataxis principles
- avoid content duplication especially for references
Our immediate goal is to leverage this documentation to showcase the deposit service(s) effectively to prospective partners.
Changes
- the new doc will live in
swh-docs/users/deposit - its entrypoints are:
- a new lvl2 chapter on the landing page under Archive source code called Deposit artefacts and/or metadata leading to the
/depositpath - a new entry is /user
- a new lvl2 chapter on the landing page under Archive source code called Deposit artefacts and/or metadata leading to the
- the documentation will follow the plan laid out in swh-deposit#4655
Screenshots
A live preview is also available on https://polite-meerkat-9b0f00.netlify.app/user/deposit/
swh-docs landing page changes
deposit services index
Merge request reports
Activity
assigned to @rboyer
added 2 commits
Jenkins job DDOC/builds #1000 failed in 16 min.
See Console Output, Blue Ocean and Coverage Report for more details.-
Jenkins job DDOC/builds #1001 failed in 16 min.
See Console Output, Blue Ocean and Coverage Report for more details. -
Jenkins job DDOC/builds #1002 failed in 16 min.
See Console Output, Blue Ocean and Coverage Report for more details. -
Jenkins job DDOC/builds #1003 failed in 9 min 51 sec.
See Console Output, Blue Ocean and Coverage Report for more details. -
Jenkins job DDOC/builds #1004 failed in 10 min.
See Console Output, Blue Ocean and Coverage Report for more details. -
Jenkins job DDOC/builds #1009 failed in 12 min.
See Console Output, Blue Ocean and Coverage Report for more details. 
Resolved by Renaud Boyerthe new
depositdoc will live inswh-docs/depositThis should rather live under
swh-docs/docs/user/depositas it is the location where we put user oriented documentation for SWH components.- Last reply by Renaud Boyer
-
Jenkins job DDOC/builds #1010 failed in 10 min.
See Console Output, Blue Ocean and Coverage Report for more details. -
Jenkins job DDOC/builds #1013 failed in 12 min.
See Console Output, Blue Ocean and Coverage Report for more details. -
Jenkins job DDOC/builds #1012 failed in 12 min.
See Console Output, Blue Ocean and Coverage Report for more details. -
Jenkins job DDOC/builds #1019 failed in 13 min.
See Console Output, Blue Ocean and Coverage Report for more details.