Change Details

First verify if the deposit documentation can be structured with Divio's ideas: https://documentation.divio.com/introduction/ As presented by Daniele Procida on: https://www.youtube.com/watch?v=t4vKPhjcMZg

First verify if the deposit documentation can be structured with Divio's ideas: https://documentation.divio.com/introduction/ As presented by Daniele Procida on: https://www.youtube.com/watch?v=t4vKPhjcMZg --------------------------------------------------------- **The current deposit table of contents is the following:** swh.deposit (Description subsection and Contents subsection) In the Description the following items are hilghligthed: - loader workers - lister workers - SWHID - reference the source code => https://hal.archives-ouvertes.fr/hal-02446202 - scientific paper => https://www.softwareheritage.org/2020/05/26/citing-software-with-style/ - save code now feature - codemeta - SWORD v2 In the Description, the list of direct links: - User Manual page - API Documentation reference pages - Hacking on swh-deposit - Deployment of the swh-deposit In the Contents, here is the full TOC: - [User Manual](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html) - [Requirements](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#requirements) - [Installation](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#installation) - [Prepare a deposit](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#prepare-a-deposit) - [Push a deposit](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#push-a-deposit) - [Update deposit](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#update-deposit) - [Check the deposit’s status](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#check-the-deposit-s-status) - [Deposit metadata](https://docs.softwareheritage.org/devel/swh-deposit/metadata.html) - [Metadata requirements](https://docs.softwareheritage.org/devel/swh-deposit/metadata.html#metadata-requirements) - [Examples](https://docs.softwareheritage.org/devel/swh-deposit/metadata.html#examples) - [Note](https://docs.softwareheritage.org/devel/swh-deposit/metadata.html#note) - [API Documentation](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html) - [Collection](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#collection) - [Limitations](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#limitations) - [API overview](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#api-overview) - [Endpoints](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#endpoints) - [Possible errors:](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#possible-errors) - [Sources](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#sources) - [Hacking on swh-deposit](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html) - [Database](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html#database) - [Development-like environment](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html#development-like-environment) - [Production-like environment](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html#production-like-environment) - [Tests](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html#tests) - [Sum up](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html#sum-up) - [Deployment of the swh-deposit](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html) - [Prepare the database setup (existence, connection, etc…).](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#prepare-the-database-setup-existence-connection-etc) - [Environment (production)](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#environment-production) - [Migrate/bootstrap the db schema](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#migrate-bootstrap-the-db-schema) - [Load minimum defaults data](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#load-minimum-defaults-data) - [Add client and collection](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#add-client-and-collection) - [Reschedule a deposit](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#reschedule-a-deposit) - [Blueprint Specifications](https://docs.softwareheritage.org/devel/swh-deposit/specs/index.html) - [Use cases](https://docs.softwareheritage.org/devel/swh-deposit/specs/blueprint.html) - [Loading specification](https://docs.softwareheritage.org/devel/swh-deposit/specs/spec-loading.html) - [Protocol reference](https://docs.softwareheritage.org/devel/swh-deposit/specs/protocol-reference.html) - [Technical specifications](https://docs.softwareheritage.org/devel/swh-deposit/specs/spec-technical.html) - [The metadata-only deposit](https://docs.softwareheritage.org/devel/swh-deposit/specs/spec-meta-deposit.html) - [Tests scenarios for client](https://docs.softwareheritage.org/devel/swh-deposit/tests/tests_HAL.html) - [Scenarios for HAL- on HAL’s platform](https://docs.softwareheritage.org/devel/swh-deposit/tests/tests_HAL.html#scenarios-for-hal-on-hal-s-platform) **Reference Documentation** - [Command-line interface](https://docs.softwareheritage.org/devel/swh-deposit/cli.html) - [Shared command-line interface](https://docs.softwareheritage.org/devel/swh-deposit/cli.html#shared-command-line-interface) - [Administration utilities](https://docs.softwareheritage.org/devel/swh-deposit/cli.html#administration-utilities) - [Deposit client tools](https://docs.softwareheritage.org/devel/swh-deposit/cli.html#deposit-client-tools) - [swh.deposit package](https://docs.softwareheritage.org/devel/apidoc/swh.deposit.html) - [Subpackages](https://docs.softwareheritage.org/devel/apidoc/swh.deposit.html#subpackages) - [Submodules](https://docs.softwareheritage.org/devel/apidoc/swh.deposit.html#submodules) - [Module contents](https://docs.softwareheritage.org/devel/apidoc/swh.deposit.html#module-swh.deposit)

First verify if the deposit documentation can be structured with Divio's ideas: https://documentation.divio.com/introduction/ As presented by Daniele Procida on: https://www.youtube.com/watch?v=t4vKPhjcMZg --------------------------------------------------------- **The current deposit table of contents is the following:** swh.deposit (Description subsection and Contents subsection) In the Description the following items are hilghligthed: - loader workers - lister workers - SWHID - reference the source code => https://hal.archives-ouvertes.fr/hal-02446202 - scientific paper => https://www.softwareheritage.org/2020/05/26/citing-software-with-style/ - save code now feature - codemeta - SWORD v2 In the Description, the list of direct links: - User Manual page - API Documentation reference pages - Hacking on swh-deposit - Deployment of the swh-deposit In the Contents, here is the full TOC: - [User Manual](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html) - [Requirements](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#requirements) - [Installation](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#installation) - [Prepare a deposit](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#prepare-a-deposit) - [Push a deposit](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#push-a-deposit) - [Update deposit](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#update-deposit) - [Check the deposit’s status](https://docs.softwareheritage.org/devel/swh-deposit/user-manual.html#check-the-deposit-s-status) - [Deposit metadata](https://docs.softwareheritage.org/devel/swh-deposit/metadata.html) - [Metadata requirements](https://docs.softwareheritage.org/devel/swh-deposit/metadata.html#metadata-requirements) - [Examples](https://docs.softwareheritage.org/devel/swh-deposit/metadata.html#examples) - [Note](https://docs.softwareheritage.org/devel/swh-deposit/metadata.html#note) - [API Documentation](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html) - [Collection](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#collection) - [Limitations](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#limitations) - [API overview](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#api-overview) - [Endpoints](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#endpoints) - [Possible errors:](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#possible-errors) - [Sources](https://docs.softwareheritage.org/devel/swh-deposit/spec-api.html#sources) - [Hacking on swh-deposit](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html) - [Database](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html#database) - [Development-like environment](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html#development-like-environment) - [Production-like environment](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html#production-like-environment) - [Tests](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html#tests) - [Sum up](https://docs.softwareheritage.org/devel/swh-deposit/dev-info.html#sum-up) - [Deployment of the swh-deposit](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html) - [Prepare the database setup (existence, connection, etc…).](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#prepare-the-database-setup-existence-connection-etc) - [Environment (production)](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#environment-production) - [Migrate/bootstrap the db schema](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#migrate-bootstrap-the-db-schema) - [Load minimum defaults data](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#load-minimum-defaults-data) - [Add client and collection](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#add-client-and-collection) - [Reschedule a deposit](https://docs.softwareheritage.org/devel/swh-deposit/sys-info.html#reschedule-a-deposit) - [Blueprint Specifications](https://docs.softwareheritage.org/devel/swh-deposit/specs/index.html) - [Use cases](https://docs.softwareheritage.org/devel/swh-deposit/specs/blueprint.html) - [Loading specification](https://docs.softwareheritage.org/devel/swh-deposit/specs/spec-loading.html) - [Protocol reference](https://docs.softwareheritage.org/devel/swh-deposit/specs/protocol-reference.html) - [Technical specifications](https://docs.softwareheritage.org/devel/swh-deposit/specs/spec-technical.html) - [The metadata-only deposit](https://docs.softwareheritage.org/devel/swh-deposit/specs/spec-meta-deposit.html) - [Tests scenarios for client](https://docs.softwareheritage.org/devel/swh-deposit/tests/tests_HAL.html) - [Scenarios for HAL- on HAL’s platform](https://docs.softwareheritage.org/devel/swh-deposit/tests/tests_HAL.html#scenarios-for-hal-on-hal-s-platform) **Reference Documentation** - [Command-line interface](https://docs.softwareheritage.org/devel/swh-deposit/cli.html) - [Shared command-line interface](https://docs.softwareheritage.org/devel/swh-deposit/cli.html#shared-command-line-interface) - [Administration utilities](https://docs.softwareheritage.org/devel/swh-deposit/cli.html#administration-utilities) - [Deposit client tools](https://docs.softwareheritage.org/devel/swh-deposit/cli.html#deposit-client-tools) - [swh.deposit package](https://docs.softwareheritage.org/devel/apidoc/swh.deposit.html) - [Subpackages](https://docs.softwareheritage.org/devel/apidoc/swh.deposit.html#subpackages) - [Submodules](https://docs.softwareheritage.org/devel/apidoc/swh.deposit.html#submodules) - [Module contents](https://docs.softwareheritage.org/devel/apidoc/swh.deposit.html#module-swh.deposit)