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
Details
Details
Description
Thu, Jul 29
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.
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
ardumont moved T3397: Improve the documentation deployment to support multiple sphinx instances from Backlog to done on the System administration board.
ardumont moved T3203: docs: Document the firewall installation and procedures from deployed/landed to done on the System administration board.
Tue, Jul 27
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]
Wed, Jul 7
Wed, Jul 7
ardumont added a comment to T3179: Add an how-to create a new swh package.
Deployed [1]
Tue, Jul 6
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.
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.
Mon, Jul 5
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.
Jun 29 2021
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.
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.
moranegg changed the status of T2234: Write use case-specific documentation from Open to Work in Progress.
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 25 2021
Jun 25 2021
ardumont closed T3388: Create FAQ in docs for users, a subtask of T3387: Create FAQ in docs, as Resolved.
ardumont added a comment to T3388: Create FAQ in docs for users.
T3397#66758 allow the deployment to be done.
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)
vsellier triaged T3407: Upgrade sphinx docker image to use a more recent version of plantuml as Normal priority.
Jun 24 2021
Jun 24 2021
moranegg updated the task description for T3297: Prepare documentation sprints 2021.
Jun 21 2021
Jun 21 2021
ardumont triaged T3397: Improve the documentation deployment to support multiple sphinx instances as Normal priority.
Jun 18 2021
Jun 18 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...
Landed and deployed on the docs site [1]
ardumont closed T3389: Create FAQ in docs for developers, a subtask of T3387: Create FAQ in docs, as Resolved.
Jun 17 2021
Jun 17 2021
ardumont added a revision to T3388: Create FAQ in docs for users: D5888: users faq: Define faq with categories.
moranegg renamed T3388: Create FAQ in docs for users from Create FAQ for users to Create FAQ in docs for users.
Jun 15 2021
Jun 15 2021
Jun 1 2021
Jun 1 2021
moranegg updated the task description for T3297: Prepare documentation sprints 2021.
May 19 2021
May 19 2021
May 10 2021
May 10 2021
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 7 2021
May 7 2021
ardumont moved T3203: docs: Document the firewall installation and procedures from Weekly backlog to code-review/monitoring on the System administration board.
May 6 2021
May 6 2021
vlorentz updated the task description for T3179: Add an how-to create a new swh package.
May 5 2021
May 5 2021