Page MenuHomeSoftware Heritage

DocumentationFolder
ActivePublic

Members

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

Recent Activity

Yesterday

moranegg triaged T2740: Update user documentation of deposit as Normal priority.
Wed, Oct 28, 3:24 PM · Documentation, SWORD deposit

Mon, Oct 19

moranegg added a comment to T2541: Write specifications on the metadata only deposit requirements and process.

More details for this task is here T2537

Mon, Oct 19, 4:46 PM · Documentation, Restricted Project, SWORD deposit, Scientific Community Building
moranegg assigned T2541: Write specifications on the metadata only deposit requirements and process to vlorentz.
Mon, Oct 19, 4:46 PM · Documentation, Restricted Project, SWORD deposit, Scientific Community Building
zack added a project to T2717: Write an end-user documentation on how to use the authenticated stack: Web app.
Mon, Oct 19, 1:33 PM · Web app, Documentation
zack added a comment to T2717: Write an end-user documentation on how to use the authenticated stack.

Agreed. In terms of where this doc go, I think it should just be a new section under https://archive.softwareheritage.org/api/ , where we already have other stuff very similar in nature. And we will be able to link to the relevant section of it via # anchors, as we already do for, e.g., rate limit.

Mon, Oct 19, 1:33 PM · Web app, Documentation
douardda triaged T2717: Write an end-user documentation on how to use the authenticated stack as High priority.
Mon, Oct 19, 1:26 PM · Web app, Documentation

Sun, Oct 18

zack added a revision to T2676: FUSE: write tutorial doc: D4297: doc: add tutorial for end users.
Sun, Oct 18, 2:10 PM · Documentation, FUSE virtual file system
zack claimed T2676: FUSE: write tutorial doc.
Sun, Oct 18, 1:34 PM · Documentation, FUSE virtual file system
zack added a revision to T2676: FUSE: write tutorial doc: D4296: [WIP] doc: add tutorial for end users.
Sun, Oct 18, 9:42 AM · Documentation, FUSE virtual file system
zack changed the status of T2676: FUSE: write tutorial doc from Open to Work in Progress.
Sun, Oct 18, 9:39 AM · Documentation, FUSE virtual file system

Fri, Oct 16

haltode moved T2673: FUSE: document configuration file location and syntax from Backlog to Done on the FUSE virtual file system board.
Fri, Oct 16, 11:30 AM · Documentation, FUSE virtual file system

Wed, Oct 14

ardumont added a revision to T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml: D4260: specs/blueprint: Align current status names and definitions.
Wed, Oct 14, 3:34 PM · SWORD deposit, Documentation
ardumont added a revision to T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml: D4257: deposit-update-chart: Clarify sequence diagram.
Wed, Oct 14, 3:27 PM · SWORD deposit, Documentation
ardumont added a revision to T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml: D4259: deposit-create-chart: Drop obsolete diagram.
Wed, Oct 14, 3:26 PM · SWORD deposit, Documentation
ardumont added a revision to T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml: D4258: deposit-delete-chart: Clarify sequence diagram.
Wed, Oct 14, 3:26 PM · SWORD deposit, Documentation
ardumont added a comment to T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml.

I improved a bit over your work.

Wed, Oct 14, 3:25 PM · SWORD deposit, Documentation
ardumont renamed T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml from Re-draw the flowcharts in swh-deposit documentation using Mermaid to Re-draw the flowcharts in swh-deposit documentation using plantuml.
Wed, Oct 14, 1:55 PM · SWORD deposit, Documentation
vlorentz added a revision to T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml: D4248: Rewrite blueprint flowcharts using Plantuml instead of .png files..
Wed, Oct 14, 12:27 PM · SWORD deposit, Documentation
vlorentz closed T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml as Resolved.
Wed, Oct 14, 12:27 PM · SWORD deposit, Documentation

Mon, Oct 12

moranegg added a comment to T1782: Document the setup of a mirror.

An interesting diagram that can fit the mirror documentation: https://www.programmevitam.fr/pages/VaS/

Mon, Oct 12, 9:42 AM · Documentation

Fri, Oct 9

haltode closed T2673: FUSE: document configuration file location and syntax as Resolved by committing rDFUSEd759b9b3b751: docs: add configuration.rst.
Fri, Oct 9, 2:18 PM · Documentation, FUSE virtual file system
haltode added a revision to T2673: FUSE: document configuration file location and syntax: D4218: docs: add configuration.rst.
Fri, Oct 9, 1:46 PM · Documentation, FUSE virtual file system

Thu, Oct 8

zack triaged T2676: FUSE: write tutorial doc as Low priority.
Thu, Oct 8, 8:21 PM · Documentation, FUSE virtual file system
zack triaged T2673: FUSE: document configuration file location and syntax as Normal priority.
Thu, Oct 8, 11:58 AM · Documentation, FUSE virtual file system

Tue, Oct 6

vlorentz added a comment to T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml.

(FYI, I'm a little busy with other things, so if someone has time on their hand, they can take over this task)

Tue, Oct 6, 10:34 AM · SWORD deposit, Documentation

Wed, Sep 30

moranegg updated the task description for T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml.
Wed, Sep 30, 11:39 AM · SWORD deposit, Documentation
moranegg added a comment to T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml.

Wed, Sep 30, 11:38 AM · SWORD deposit, Documentation
moranegg added a comment to T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml.

Wed, Sep 30, 11:37 AM · SWORD deposit, Documentation
moranegg added a comment to T2618: Re-draw the flowcharts in swh-deposit documentation using plantuml.

Wed, Sep 30, 11:37 AM · SWORD deposit, Documentation
moranegg moved T2541: Write specifications on the metadata only deposit requirements and process from High priority to In progress on the SWORD deposit board.
Wed, Sep 30, 11:12 AM · Documentation, Restricted Project, SWORD deposit, Scientific Community Building
moranegg moved T2541: Write specifications on the metadata only deposit requirements and process from Backlog to High priority on the SWORD deposit board.
Wed, Sep 30, 11:12 AM · Documentation, Restricted Project, SWORD deposit, Scientific Community Building

Sep 24 2020

zack added a comment to T2624: Create strategy for documentation with a map or a full table of content.

For whoever who want to work on this (and on doc restructuring in general), I recommend to watch this talk: https://www.youtube.com/watch?v=t4vKPhjcMZg , which provides a good taxonomy of the kind of docs that exist. Our GSoD 2019 application page also contains a lot of useful related work.

Sep 24 2020, 4:48 PM · Documentation
douardda added a comment to T2624: Create strategy for documentation with a map or a full table of content.

Also https://plan.io/blog/technical-documentation/

Sep 24 2020, 3:43 PM · Documentation
douardda added a comment to T1330: Ensure documentation building process does not generates any rst syntax warning.

I'd like to close this task, but unfortunately:

Sep 24 2020, 2:47 PM · Documentation
douardda closed T358: doc: high-level architecture diagram, a subtask of T509: Generate and publish Software Heritage Development Documentation, as Resolved.
Sep 24 2020, 2:42 PM · Documentation
douardda closed T358: doc: high-level architecture diagram as Resolved.

I guess we can say that, let's close this.

Sep 24 2020, 2:42 PM · Documentation

Sep 23 2020

moranegg moved T2631: Document the UID/GID ranges for the swh infra from Backlog to sys-admin on the Documentation board.
Sep 23 2020, 11:20 PM · Documentation, System administration
moranegg added a project to T2541: Write specifications on the metadata only deposit requirements and process: Documentation.
Sep 23 2020, 11:18 PM · Documentation, Restricted Project, SWORD deposit, Scientific Community Building
moranegg added a project to T2631: Document the UID/GID ranges for the swh infra: Documentation.
Sep 23 2020, 11:17 PM · Documentation, System administration

Sep 22 2020

moranegg moved T1345: Update metadata docs about using CodeMeta vocabulary from Backlog to community on the Documentation board.
Sep 22 2020, 4:45 PM · Documentation, SWORD deposit, Metadata workflow
moranegg moved T1752: Test drive legacy software curation process from Backlog to community on the Documentation board.
Sep 22 2020, 4:45 PM · Documentation, Acquisition Process (SWHAP), Metadata workflow, Scientific Community Building
moranegg moved T2079: Prepare collaborative document for how to use SWHID on WikiData for preservation and discovery from Backlog to community on the Documentation board.
Sep 22 2020, 4:45 PM · Documentation, Metadata workflow, Wikidata
moranegg added a project to T1752: Test drive legacy software curation process: Documentation.
Sep 22 2020, 4:45 PM · Documentation, Acquisition Process (SWHAP), Metadata workflow, Scientific Community Building
moranegg added a project to T1345: Update metadata docs about using CodeMeta vocabulary: Documentation.
Sep 22 2020, 4:44 PM · Documentation, SWORD deposit, Metadata workflow
moranegg added a project to T2079: Prepare collaborative document for how to use SWHID on WikiData for preservation and discovery: Documentation.
Sep 22 2020, 4:31 PM · Documentation, Metadata workflow, Wikidata
moranegg added a comment to T2624: Create strategy for documentation with a map or a full table of content.

Examples for a community driven documentation:

Sep 22 2020, 3:41 PM · Documentation
moranegg triaged T2624: Create strategy for documentation with a map or a full table of content as High priority.
Sep 22 2020, 3:28 PM · Documentation
moranegg moved T2050: Create page "how to contribute" (dev, docs, tasks) as a first steps guide in SWH from developers to community on the Documentation board.
Sep 22 2020, 3:21 PM · Documentation
moranegg moved T1330: Ensure documentation building process does not generates any rst syntax warning from Backlog to building docs on the Documentation board.
Sep 22 2020, 3:16 PM · Documentation
moranegg moved T1905: lint docstrings with pydocstyle from Backlog to building docs on the Documentation board.
Sep 22 2020, 3:11 PM · Documentation