Page MenuHomeSoftware Heritage

DocumentationFolder
ActivePublic

Members

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

Recent Activity

Wed, Jan 20

moranegg added a project to T2920: Document staging infrastructure: Documentation.
Wed, Jan 20, 10:33 AM · Documentation, System administration, Staging environment

Fri, Jan 15

moranegg updated subscribers of T2894: Restructure deposit documentation with a clearer strategy.

Please free to complete or comment specific parts of this overview:

Fri, Jan 15, 3:29 PM · SWORD deposit, Documentation
moranegg updated the task description for T2894: Restructure deposit documentation with a clearer strategy.
Fri, Jan 15, 2:33 PM · SWORD deposit, Documentation
moranegg added a comment to T2624: Create strategy for documentation with a map or a full table of content.

An idea for a strategy:
a "features" page on the website (which can be under About or under Archive)

Fri, Jan 15, 12:50 PM · Documentation

Mon, Jan 11

dachary added a comment to T2946: pre-commit is required by bin/update.

Thanks for the merge :-) It feels really good to see a commit, however simple, being merged on a Monday morning!

Mon, Jan 11, 10:53 AM · Easy hack, Documentation
zack closed T2946: pre-commit is required by bin/update as Resolved by committing rDDOC23eb98acef51: bin/update fails unless pre-commit is installed.
Mon, Jan 11, 10:34 AM · Easy hack, Documentation

Sat, Jan 9

dachary added a comment to T2946: pre-commit is required by bin/update.

bin/update contains

Sat, Jan 9, 7:25 PM · Easy hack, Documentation
zack added a comment to T2946: pre-commit is required by bin/update.

Thanks for the bug report. Do you have a log of what happens upon bin/update if pre-commit is missing? (it's sure is needed for committing, but i'm surprised it's needed for bin/update).
Also, is it needed for a raw "bin/update" or only for "bin/update -i" (that also install Python dependencies?).

Sat, Jan 9, 5:30 PM · Easy hack, Documentation

Fri, Jan 8

dachary added a project to T2946: pre-commit is required by bin/update: Easy hack.
Fri, Jan 8, 11:45 PM · Easy hack, Documentation
dachary triaged T2946: pre-commit is required by bin/update as Low priority.
Fri, Jan 8, 11:41 PM · Easy hack, Documentation

Wed, Jan 6

douardda added a comment to T2089: Write user stories entering the SWH world and its documentation .

This list of user stories is something that can be written in a wiki.
@douardda or do you prefer having this list of scenarios in the docs ( for example in: docs.softwareheritage.org/user-stories)

Wed, Jan 6, 9:44 AM · Documentation

Tue, Dec 29

vlorentz closed T2917: document minimum required Python version as Resolved by committing rDDOC33cbf4d46707: Rephrase Python version requirement and make it stand out more..
Tue, Dec 29, 12:41 PM · Easy hack, Documentation
vlorentz added a revision to T2917: document minimum required Python version: D4796: Rephrase Python version requirement and make it stand out more..
Tue, Dec 29, 1:10 AM · Easy hack, Documentation

Mon, Dec 28

zack added a comment to T2917: document minimum required Python version.
In T2917#55617, @zvr wrote:

Please, not only document but add to the code something like
python_requires='>=3.7'
to setup.py so that the Pypi packages are not installable in older versions.

Mon, Dec 28, 6:14 PM · Easy hack, Documentation
zvr added a comment to T2917: document minimum required Python version.

Please, not only document but add to the code something like
python_requires='>=3.7'
to setup.py so that the Pypi packages are not installable in older versions.

Mon, Dec 28, 4:20 PM · Easy hack, Documentation
zack added a project to T2917: document minimum required Python version: Easy hack.
Mon, Dec 28, 3:55 PM · Easy hack, Documentation
zack triaged T2917: document minimum required Python version as High priority.
Mon, Dec 28, 3:55 PM · Easy hack, Documentation
zack renamed T2917: document minimum required Python version from Is Python 3.6 the minimum version supported? to document minimum required Python version.
Mon, Dec 28, 3:54 PM · Easy hack, Documentation
zack added a project to T2917: document minimum required Python version: Documentation.

Yeah, we really depend on recent-ish Python (and not only for f-strings, a lot of typing-related stuff also comes to mind).
3.5 is no longer supported (and I have my doubts about 3.6 too; we generally follow Debian stable, which is on Python 3.7 now).

Mon, Dec 28, 3:54 PM · Easy hack, Documentation
haltode moved T2825: add origin (and search) example to the FUSE tutorial from In progress to Done on the Software Heritage filesystem board.
Mon, Dec 28, 1:35 PM · Documentation, Software Heritage filesystem
haltode closed T2825: add origin (and search) example to the FUSE tutorial as Resolved by committing rDFUSE4b304d38eee0: docs: tutorial: add origin and search examples.
Mon, Dec 28, 1:35 PM · Documentation, Software Heritage filesystem
haltode added a revision to T2825: add origin (and search) example to the FUSE tutorial: D4793: FUSE: docs: tutorial: add origin and search examples.
Mon, Dec 28, 11:40 AM · Documentation, Software Heritage filesystem
haltode changed the status of T2825: add origin (and search) example to the FUSE tutorial from Open to Work in Progress.
Mon, Dec 28, 11:37 AM · Documentation, Software Heritage filesystem
zack placed T2825: add origin (and search) example to the FUSE tutorial up for grabs.
Mon, Dec 28, 9:11 AM · Documentation, Software Heritage filesystem

Wed, Dec 23

ardumont triaged T2915: Add documentation about the inventory webapp as Normal priority.
Wed, Dec 23, 6:38 PM · Documentation

Dec 23 2020

zack triaged T2914: mirror documentation: add ballpark storage/infra requirements as Normal priority.
Dec 23 2020, 1:55 PM · Mirror, Documentation

Dec 18 2020

ardumont added a comment to T2894: Restructure deposit documentation with a clearer strategy.

I'm sold on this. Thanks for the link.

Dec 18 2020, 9:35 PM · SWORD deposit, Documentation

Dec 16 2020

moranegg triaged T2894: Restructure deposit documentation with a clearer strategy as High priority.
Dec 16 2020, 3:55 PM · SWORD deposit, Documentation
moranegg added a comment to T2624: Create strategy for documentation with a map or a full table of content.

@zack very good video!
Here is a short summary from the video (Daniele Procida) and from Divio's documentation website:
https://documentation.divio.com/
Four different functions:

Dec 16 2020, 3:51 PM · Documentation
moranegg added a comment to T2179: Document user stories on website or archive.

https://www.uxmatters.com/mt/archives/2010/10/using-personas-during-design-and-documentation.php
Create persona documentation. When writing personas, include the following information:

Dec 16 2020, 3:26 PM · Documentation
moranegg added a comment to T2893: Create user personas to clarify who are the users reading the documentation.

Here is the stakeholder landscape that was created for the SCID WG output (RDA & FORCE11)

Dec 16 2020, 3:19 PM · Documentation
moranegg triaged T2893: Create user personas to clarify who are the users reading the documentation as Normal priority.
Dec 16 2020, 3:19 PM · Documentation
moranegg added a comment to T2089: Write user stories entering the SWH world and its documentation .

A summary of the following article:
https://blog.prototypr.io/software-documentation-types-and-best-practices-1726ca595c7f

Product documentation
Process documentation
Dec 16 2020, 3:14 PM · Documentation

Dec 15 2020

zack claimed T2825: add origin (and search) example to the FUSE tutorial.
Dec 15 2020, 11:26 AM · Documentation, Software Heritage filesystem
douardda closed T2818: Document the journal topics as Resolved by committing rDDOC83a7f94474c1: Add a documentation/specification of the journal messages formats.
Dec 15 2020, 10:32 AM · Documentation

Dec 14 2020

moranegg triaged T2887: Show the version of the swh-module in the deployed documentation as Normal priority.
Dec 14 2020, 3:31 PM · Documentation
zack renamed T2825: add origin (and search) example to the FUSE tutorial from add origin example to the FUSE tutorial to add origin (and search) example to the FUSE tutorial.
Dec 14 2020, 1:23 PM · Documentation, Software Heritage filesystem

Dec 11 2020

zack renamed T2793: add notable past events to the archive changelog from add to the journal of archive changes notable past events to add notable past events to the archive changelog.
Dec 11 2020, 4:24 PM · Archive coverage, Documentation
zack closed T2793: add notable past events to the archive changelog as Resolved by committing rDDOCde792f8fd73a: archive changelog: remove WIP mark.
Dec 11 2020, 4:23 PM · Archive coverage, Documentation
zack updated the task description for T2793: add notable past events to the archive changelog.
Dec 11 2020, 4:21 PM · Archive coverage, Documentation
zack updated the task description for T2793: add notable past events to the archive changelog.
Dec 11 2020, 3:57 PM · Archive coverage, Documentation
ardumont added a comment to T2740: Update user documentation of deposit.

til, moving task within the dashboard changes the status of the task...

Dec 11 2020, 3:25 PM · Documentation, SWORD deposit
ardumont closed T2740: Update user documentation of deposit as Resolved.
Dec 11 2020, 3:24 PM · Documentation, SWORD deposit
ardumont added a comment to T2740: Update user documentation of deposit.

Can I resolve this task?

Dec 11 2020, 3:24 PM · Documentation, SWORD deposit
zack updated the task description for T2793: add notable past events to the archive changelog.
Dec 11 2020, 3:07 PM · Archive coverage, Documentation

Dec 10 2020

zack added a comment to T2793: add notable past events to the archive changelog.

I've completed a bunch of these in 86f8b213e23970feb9f9bda8ab87fc7d6851abf0

Dec 10 2020, 4:55 PM · Archive coverage, Documentation
zack updated the task description for T2793: add notable past events to the archive changelog.
Dec 10 2020, 4:54 PM · Archive coverage, Documentation
zack updated the task description for T2793: add notable past events to the archive changelog.
Dec 10 2020, 4:21 PM · Archive coverage, Documentation
zack updated the task description for T2793: add notable past events to the archive changelog.
Dec 10 2020, 11:30 AM · Archive coverage, Documentation
zack updated the task description for T2793: add notable past events to the archive changelog.
Dec 10 2020, 11:28 AM · Archive coverage, Documentation