Page MenuHomeSoftware Heritage

DocumentationFolder
ActivePublic

Members

  • This project does not have any members.
  • View All

Details

Description

Step 1: Be exhaustive and clear on tasks
Step 2: Provide structures and links between locations
Step 3: Improve current diff requirements to include documentation of change
Step 4: Re-organize existing information
Step 5: Write missing guides and information

Recent Activity

Thu, Jul 29

vlorentz moved T2431: Document how to export the graph edge dataset from sys-admin (docs/sysadm) to developers (docs/devel/) on the Documentation board.
Thu, Jul 29, 3:54 PM · Documentation, Graph service, Datasets
vlorentz moved T2431: Document how to export the graph edge dataset from archive-users (docs/user-guides/) to sys-admin (docs/sysadm) on the Documentation board.
Thu, Jul 29, 3:54 PM · Documentation, Graph service, Datasets
vlorentz added a comment to T2431: Document how to export the graph edge dataset.

It is now somewhat documented here: https://forge.softwareheritage.org/source/swh-environment/browse/master/docker/services/swh-graph/entrypoint.sh

Thu, Jul 29, 3:54 PM · Documentation, Graph service, Datasets
ardumont moved T3397: Improve the documentation deployment to support multiple sphinx instances from Backlog to done on the System administration board.
Thu, Jul 29, 1:24 PM · System administration, Documentation
ardumont moved T3203: docs: Document the firewall installation and procedures from deployed/landed to done on the System administration board.
Thu, Jul 29, 1:21 PM · Documentation, System administration

Tue, Jul 27

ardumont added a comment to T3154: proposal: sysadm docs: Move relevant and public doc from intranet to swh-docs.

The sysadm team is ok on this [1]

Tue, Jul 27, 8:50 AM · Documentation

Wed, Jul 7

ardumont closed T3179: Add an how-to create a new swh package as Resolved.
Wed, Jul 7, 11:07 AM · Documentation
ardumont added a comment to T3179: Add an how-to create a new swh package.

Deployed [1]

Wed, Jul 7, 11:07 AM · Documentation

Tue, Jul 6

ardumont added a comment to T3179: Add an how-to create a new swh package.

Hedgedoc draft marked as deprecated.
Diff in pending review.
Hopefully, that shall land and get deployed soon.

Tue, Jul 6, 5:28 PM · Documentation
ardumont renamed T3179: Add an how-to create a new swh package from Add an how-to create a new swh module to Add an how-to create a new swh package.
Tue, Jul 6, 5:26 PM · Documentation
ardumont claimed T3179: Add an how-to create a new swh package.
Tue, Jul 6, 5:25 PM · Documentation

Mon, Jul 5

ardumont added a revision to T3179: Add an how-to create a new swh package: D5968: Add an how-to add a new swh package.
Mon, Jul 5, 3:55 PM · Documentation

Jun 29 2021

moranegg moved T2624: Create strategy for documentation with a map or a full table of content from Backlog to Pending validation on the Roadmap 2021 board.
Jun 29 2021, 10:53 AM · Roadmap 2021, meta-task, Documentation
moranegg changed the status of T2234: Write use case-specific documentation, a subtask of T2233: Update documentation to current project status, from Open to Work in Progress.
Jun 29 2021, 10:53 AM · Documentation, meta-task, Roadmap 2020
moranegg changed the status of T2234: Write use case-specific documentation from Open to Work in Progress.
Jun 29 2021, 10:53 AM · Roadmap 2021, meta-task, Documentation
moranegg removed a project from T3387: Create FAQ in docs: Roadmap 2021.
Jun 29 2021, 10:51 AM · Documentation
vlorentz removed a project from T3390: Create FAQ in docs for sys-admins: Roadmap 2021.
Jun 29 2021, 10:51 AM · Documentation
moranegg added a subtask for T2624: Create strategy for documentation with a map or a full table of content: T3297: Prepare documentation sprints 2021.
Jun 29 2021, 10:03 AM · Roadmap 2021, meta-task, Documentation
moranegg added a parent task for T3297: Prepare documentation sprints 2021: T2624: Create strategy for documentation with a map or a full table of content.
Jun 29 2021, 10:03 AM · Documentation
moranegg renamed T2893: Identify user personas to clarify who are the users reading the documentation from Create user personas to clarify who are the users reading the documentation to Identify user personas to clarify who are the users reading the documentation.
Jun 29 2021, 9:49 AM · Documentation

Jun 25 2021

ardumont closed T3388: Create FAQ in docs for users, a subtask of T3387: Create FAQ in docs, as Resolved.
Jun 25 2021, 5:10 PM · Documentation
ardumont closed T3388: Create FAQ in docs for users as Resolved.
Jun 25 2021, 5:10 PM · Documentation, Roadmap 2021
ardumont added a comment to T3388: Create FAQ in docs for users.

T3397#66758 allow the deployment to be done.

Jun 25 2021, 5:10 PM · Documentation, Roadmap 2021
ardumont closed T3397: Improve the documentation deployment to support multiple sphinx instances as Resolved.

Done through [1] [2] and update manually the jenkins configuration so the default remote
directory on pergamon is /srv/softwareheritage/docs/webroot (and not longer
/srv/softwareheritage/docs/webroot/devel)

Jun 25 2021, 5:09 PM · System administration, Documentation
vsellier triaged T3407: Upgrade sphinx docker image to use a more recent version of plantuml as Normal priority.
Jun 25 2021, 3:44 PM · System administration, Documentation

Jun 24 2021

moranegg updated the task description for T3297: Prepare documentation sprints 2021.
Jun 24 2021, 2:57 PM · Documentation
ardumont changed the status of T3387: Create FAQ in docs from Open to Work in Progress.
Jun 24 2021, 2:11 PM · Documentation

Jun 21 2021

ardumont triaged T3397: Improve the documentation deployment to support multiple sphinx instances as Normal priority.
Jun 21 2021, 11:15 AM · System administration, Documentation

Jun 18 2021

ardumont added a revision to T3388: Create FAQ in docs for users: D5898: docs: Update build to deploy the "users" sphinx instance.
Jun 18 2021, 3:49 PM · Documentation, Roadmap 2021
ardumont added a revision to T3388: Create FAQ in docs for users: D5897: docs: Update tox.ini to build the "users" sphinx instance.
Jun 18 2021, 3:49 PM · Documentation, Roadmap 2021
ardumont added a comment to T3388: Create FAQ in docs for users.

Landed but some more change in the build pipeline need to happen.
Currently looking into it...

Jun 18 2021, 3:45 PM · Documentation, Roadmap 2021
ardumont closed T3389: Create FAQ in docs for developers as Resolved.

Landed and deployed on the docs site [1]

Jun 18 2021, 3:44 PM · Documentation, Roadmap 2021
ardumont closed T3389: Create FAQ in docs for developers, a subtask of T3387: Create FAQ in docs, as Resolved.
Jun 18 2021, 3:44 PM · Documentation

Jun 17 2021

ardumont added a revision to T3388: Create FAQ in docs for users: D5888: users faq: Define faq with categories.
Jun 17 2021, 5:59 PM · Documentation, Roadmap 2021
moranegg triaged T3390: Create FAQ in docs for sys-admins as Normal priority.
Jun 17 2021, 2:44 PM · Documentation
moranegg triaged T3389: Create FAQ in docs for developers as Normal priority.
Jun 17 2021, 2:43 PM · Documentation, Roadmap 2021
moranegg renamed T3388: Create FAQ in docs for users from Create FAQ for users to Create FAQ in docs for users.
Jun 17 2021, 2:42 PM · Documentation, Roadmap 2021
moranegg triaged T3388: Create FAQ in docs for users as Normal priority.
Jun 17 2021, 2:42 PM · Documentation, Roadmap 2021
moranegg renamed T3387: Create FAQ in docs from create FAQ in docs to Create FAQ in docs.
Jun 17 2021, 2:41 PM · Documentation
moranegg triaged T3387: Create FAQ in docs as Normal priority.
Jun 17 2021, 2:38 PM · Documentation

Jun 15 2021

anlambert added a revision to T1110: document GitHub caseness caveats: D5877: assets/save: Ensure to use canonical github repo URL as origin URL.
Jun 15 2021, 5:58 PM · GitHub lister, Documentation

Jun 1 2021

moranegg updated the task description for T3297: Prepare documentation sprints 2021.
Jun 1 2021, 5:26 PM · Documentation

May 19 2021

vlorentz added a project to T3333: Document the different storage backends: Documentation.
May 19 2021, 11:12 AM · Documentation, Storage manager

May 10 2021

vsellier added a revision to T3203: docs: Document the firewall installation and procedures: D5727: infrastructure: fix sphinx warnings.
May 10 2021, 5:41 PM · Documentation, System administration
anlambert added a comment to T3258: Build documentation on every diff.

We should also build the whole documentation when submitting a diff to swh-docs, some sphinx errors not related to packages documentation could be caught this way (see https://jenkins.softwareheritage.org/job/DDOC/job/dev/5700/artifact/swh-docs/docs/errors.log)

May 10 2021, 12:08 PM · Continuous Integration, Development environment, Documentation

May 7 2021

vsellier closed T3203: docs: Document the firewall installation and procedures as Resolved.
May 7 2021, 2:52 PM · Documentation, System administration
ardumont moved T3203: docs: Document the firewall installation and procedures from Weekly backlog to code-review/monitoring on the System administration board.
May 7 2021, 12:07 PM · Documentation, System administration

May 6 2021

vlorentz updated the task description for T3179: Add an how-to create a new swh package.
May 6 2021, 5:00 PM · Documentation
vsellier added a revision to T3203: docs: Document the firewall installation and procedures: D5692: document the firewalls upgrade procedure.
May 6 2021, 11:12 AM · Documentation, System administration

May 5 2021

vsellier closed T3307: apidoc generation is not performed on swh modules during dev build as Resolved.
May 5 2021, 2:52 PM · Continuous Integration, Documentation