Page MenuHomeSoftware Heritage
Create Task
Maniphest T509

Generate and publish Software Heritage Development Documentation
Closed, MigratedEdits Locked
Actions

Description

We need to generate some top-level documentation for Software Heritage developers (both core team and external contributors).

This will mostly be the API doc of the Python modules, but additional ad hoc documents will need to be written, and in the future we might encompass other languages used in our technology mix (we already have SQL, for instance).

Related Objects
Search...

Event Timeline

olasd created this task.Jul 26 2016, 12:55 PM
olasd added subtasks: T371: Consistent documentation for Python modules, T358: doc: high-level architecture diagram.
zack changed the status of subtask T358: doc: high-level architecture diagram from Open to Work in Progress.Feb 12 2017, 6:20 PM
zack changed the task status from Open to Work in Progress.Aug 30 2017, 2:04 PM
zack claimed this task.
zack changed the status of subtask T371: Consistent documentation for Python modules from Open to Work in Progress.
zack created subtask T750: publish static HTML version of the Software Heritage development documentation.Aug 30 2017, 2:11 PM
zack renamed this task from Generate top-level documentation for the Software Heritage Python stack to Generate and publish Software Heritage Development Documentation.Aug 30 2017, 2:14 PM
zack updated the task description. (Show Details)
zack created subtask T751: integrate module dependency graph into swh-docs.
zack closed subtask T371: Consistent documentation for Python modules as Resolved.Sep 7 2017, 3:40 PM
zack closed subtask T750: publish static HTML version of the Software Heritage development documentation as Resolved.
zack closed subtask T751: integrate module dependency graph into swh-docs as Resolved.Sep 13 2017, 5:04 PM
zack created subtask T762: integrate lister tutorial into development documentation.Sep 15 2017, 10:13 AM
zack created subtask T787: abstract data model (Merkle DAG) documentation.Oct 2 2017, 1:57 PM
zack closed subtask T762: integrate lister tutorial into development documentation as Resolved.Nov 2 2017, 5:54 PM
zack changed the status of subtask T787: abstract data model (Merkle DAG) documentation from Open to Work in Progress.Feb 23 2018, 1:35 PM
zack closed this task as Resolved.Apr 27 2018, 8:09 PM

This is now done as a generic goal. Bits and pieces of the doc are still in progress, but the generic doc infrastructure is now in place.

zack closed subtask T787: abstract data model (Merkle DAG) documentation as Resolved.Jun 13 2018, 4:01 PM
douardda closed subtask T358: doc: high-level architecture diagram as Resolved.Sep 24 2020, 2:42 PM
gitlab-migration changed the task status from Resolved to Migrated.Jan 8 2023, 4:18 PM
gitlab-migration claimed this task.
gitlab-migration changed the status of subtask T358: doc: high-level architecture diagram from Resolved to Migrated.
gitlab-migration changed the status of subtask T371: Consistent documentation for Python modules from Resolved to Migrated.
gitlab-migration added subscribers: zack, gitlab-migration.

This task has been migrated to GitLab.

gitlab-migration changed the status of subtask T750: publish static HTML version of the Software Heritage development documentation from Resolved to Migrated.Jan 8 2023, 4:21 PM
gitlab-migration changed the status of subtask T751: integrate module dependency graph into swh-docs from Resolved to Migrated.
gitlab-migration changed the status of subtask T762: integrate lister tutorial into development documentation from Resolved to Migrated.
gitlab-migration changed the status of subtask T787: abstract data model (Merkle DAG) documentation from Resolved to Migrated.Jan 8 2023, 4:23 PM
About · Developer information · Legal