Page MenuHomeSoftware Heritage

Triage documentation in wiki
Open, LowPublic

Description

The Software Heritage wiki contain crowd-sourced documentation but is not very visible.
With this task we search for a decision-process to triage wiki pages into four categories:

  1. should be in website (visibility for visitors)
  2. should be in docs (visibility for users/contributors)
  3. should stay as wiki page (with motivation)
  4. should be removed

Please edit this task or add comments with the wiki page and the following properties:

wiki pagefor who (visitor/user/contributor)can be attached to another page?category (1/2/3)possible solutionmaintenance frequency
Archive??4 (almost empty)??
Best practices using metadatacontributor????
Cheatsheet?44 (redirect to empty page, orphan)??
ClearlyDefinedObjectcontributor (dev only)?3 (scratchpad for Tushar)??
CodeMetacontributor?4 (outdated)??
Code citation?????
Code hosters?????
Code of conductuser & contributor?1 (no reason for it to be editable)??
Code search?????
Coding guidelinescontributor (dev only)????
Compression ratio?????
Content archiver blueprintcontributor?4 (almost empty, outdated)??
Contributor License Agreementcontributor?1 (no reason for it to be editable)??
Debian packagingcontributor????
Easy hackscontributor????
External contribution integrationcontributor????
Forgescontributor????
Glossaryeveryone????
Graph Dataset on Amazon Athenauser (dev only)????
Je suis GPL? (dev only)?4 (almost empty, has a git repo with a readme)??
Licensing??? (orphan)?outdated (2 years)
Local elasticsearch? (dev only)????
Lost codevisitor????
Main Pageeveryone?3 (homepage of the wiki)??
Manifests??4 (almost empty)??
Metadata initiatives?????
Original Main Page??4 (outdated)??
Presentation with org beamer?????
Python module layoutcontributor (dev only)????
Python package layoutcontributor (dev only)????
Python style guidecontributor (dev only)?2 (done)??
Repository snapshot objects?????
Software Catalogs?????
Software heritage?????
Software Heritage?????
Software Heritage archive??4 (almost empty)??
Software Heritage cheatsheet??4 (almost empty, orphan)??
Software Heritage identifiers?????
Software Heritage licensing??4 (redirect, orphan)?outdated (2 years)
Software Heritage requirements??2 (done)?outdated (4 years)
Sphinx gotchascontributor????
Statistics?????
Statistics/Content size?????
Status page?????
Suggestion box: source code to addvisitor & contributor?3 (easier to edit and see who edited the page)?medium
Suggestion box: source code to add/Debian derivativesvisitor & contributor????
Suggestion box: source code to add/KDEvisitor & contributor????
TalksvisitorPublications on site?1 ?add link to annexhigh
Testing the archive features?????
Vault Blueprint??4 (outdated)??

pages about tools used to work on SWH

(ie. tools used to work together, not tools used by the archive)

wiki pagefor who (visitor/user/contributor)can be attached to another page?category (1/2/3)possible solutionmaintenance frequency
Arcanistcontributor (git only)?2 (done)??
Arcanist setupcontributor (git only)?2 (done)??
Code reviewcontributor (dev only)?2 (done)??
Code review in Phabricatorcontributor (dev only)?2 (done)??
Continuous Integrationcontributor (dev only)????
Continuous integrationcontributor (dev only)????
Differentialcontributor?4 (empty)??
Forgesysadmin (and contributor?)?4 (redirect to almost-empty page)??
Gitcontributor (git only)?4 (orphan + almost empty)??
Git repositoriescontributor (git only)?4 (orphan + almost empty)??
Git style guidecontributor (git only)?2 (done)??
HedgeDoc?????
IRCeveryone????
IRC channelseveryone????
Jenkinscontributor (git only)????
Mailing listseveryone????
Phabricatorsysadmin (and contributor?)?move to intranet??
Phabricator callsign naming conventioncontributor????
Private wikicontributor????
Public wikieveryone????
Report issues on phabricatoruser????
Wiki??3 (it's about the wiki itself)??
Wiki editing conventionscontributor?3 (it's about the wiki itself)??

bibliography + pages about other organizations/projects

pages about working groups

pages about non-public resources / infra

wiki pagefor who (visitor/user/contributor)can be attached to another page?category (1/2/3)possible solutionmaintenance frequency
Ceph Clustersysadmin????
Dell MD3460sysadmin????
Intranet?????
Libvirt Disk Configurationsysadmin????
Puppet setupsysadmin????
Streaming Replicationsysadmin?4 (already moved)??
New machine setupsysadmin????
VPNcontributor????
Softwareheritage-ca.crtcontributor????

internship pages

wiki pagefor who (visitor/user/contributor)can be attached to another page?category (1/2/3)possible solutionmaintenance frequency
all internship pagesvisitor (students)no3 (ease of maintenance / status update)nothing to doas-need basis
Archive search query language (internship)
Code scanner (internship)
Crawling project metadata (internship)
CVS loader (internship)
Darcs loader (internship)
Distributed self-healing object storage (internship)
Expand archive coverage to Debian-based distros (internship)
Expand archive coverage to other popular code hosting platforms (internship)
Expand metadata search coverage (internship)
Fine-grained tracking of source code provenance (internship)
Git remote support for Software Heritage (internship)
Google Season of Docs 2019
Google Summer of Code 2019
Google Summer of Code 2019/Graph compression
Google Summer of Code 2019/Graph compression/Commit list
Google Summer of Code 2019/Increase archive coverage
Google Summer of Code 2019/Increase archive coverage/Commit list
Google Summer of Code 2019/Web UI improvements
Google Summer of Code 2019/Web UI improvements/Commit list
Google Summer of Code 2020
Google Summer of Code 2021
Graph compression on the development history of software (internship)
Graph compression on the history of software (internship)
Graph query language for the archive (internship)
Gsoc
Gsod
Improve and extend the archive Web UI (GSoC task)
Improve project search engine (GSoC task)
Improve the Vault (GSoC task)
Ingest Wikidata software origins (internship)
Ingest all Debian derivatives (internship)
Integrate Software Heritage and ClearlyDefined (internship)
Integrate Software Heritage and GHTorrent (internship)
Integrating Software Heritage and GHTorrent (internship)
Internship
Internships
Language and infrastructure for analyzing the archive (internship)
Language and infrastructure for analyzing the archive (internship)/fr
Large-scale license text recognition (internship)
Large-scale license text recognition (internship)/fr
Large-scale progamming language detection (internship)
Mercurial and Darcs loaders (internship)
Mine information from archived content (GSoC task)
Mine information from external sources (GSoC task)
Python bindings for WebGraph (internship)
Software Heritage internships
Source code search engine prototype (internship)
Summer of Code 2019
The Vault (internship)
Virtual Software Heritage filesystem (internship)
Web UI (internship)
Web UI improvements (internship)

Event Timeline

moranegg lowered the priority of this task from High to Low.
moranegg created this task.
moranegg updated the task description. (Show Details)
vlorentz updated the task description. (Show Details)
vlorentz updated the task description. (Show Details)
vlorentz updated the task description. (Show Details)
vlorentz updated the task description. (Show Details)
vlorentz updated the task description. (Show Details)
vlorentz updated the task description. (Show Details)
vlorentz updated the task description. (Show Details)

(thanks for this!)

i've merged together all internship pages in the table, and provided an explanation of why (in my opinion) they are good where they are