Triage documentation in wiki
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:
- should be in website (visibility for visitors)
- should be in docs (visibility for users/contributors)
- should stay as wiki page (with motivation)
- should be removed
Please edit this task or add comments with the wiki page and the following properties:
| wiki page | for who (visitor/user/contributor) | can be attached to another page? | category (1/2/3) | possible solution | maintenance frequency |
|---|---|---|---|---|---|
| Archive | ? | ? | 4 (almost empty) | ? | ? |
| Best practices using metadata | contributor | ? | ? | ? | ? |
| Cheatsheet | ? | 4 | 4 (redirect to empty page, orphan) | ? | ? |
| ClearlyDefinedObject | contributor (dev only) | ? | 3 (scratchpad for Tushar) | ? | ? |
| CodeMeta | contributor | ? | 4 (outdated) | ? | ? |
| Code citation | ? | ? | ? | ? | ? |
| Code hosters | ? | ? | ? | ? | ? |
| Code of conduct | user & contributor | ? | 1 (no reason for it to be editable) | ? | ? |
| Code search | ? | ? | ? | ? | ? |
| Coding guidelines | contributor (dev only) | ? | ? | ? | ? |
| Compression ratio | ? | ? | ? | ? | ? |
| Content archiver blueprint | contributor | ? | 4 (almost empty, outdated) | ? | ? |
| Contributor License Agreement | contributor | ? | 1 (no reason for it to be editable) | ? | ? |
| Debian packaging | contributor | ? | ? | ? | ? |
| Easy hacks | contributor | ? | ? | ? | ? |
| External contribution integration | contributor | ? | ? | ? | ? |
| Forges | contributor | ? | ? | ? | ? |
| Glossary | everyone | ? | ? | ? | ? |
| Graph Dataset on Amazon Athena | user (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 code | visitor | ? | ? | ? | ? |
| Main Page | everyone | ? | 3 (homepage of the wiki) | ? | ? |
| Manifests | ? | ? | 4 (almost empty) | ? | ? |
| Metadata initiatives | ? | ? | ? | ? | ? |
| Original Main Page | ? | ? | 4 (outdated) | ? | ? |
| Presentation with org beamer | ? | ? | ? | ? | ? |
| Python module layout | contributor (dev only) | ? | ? | ? | ? |
| Python package layout | contributor (dev only) | ? | ? | ? | ? |
| Python style guide | contributor (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 gotchas | contributor | ? | ? | ? | ? |
| Statistics | ? | ? | ? | ? | ? |
| Statistics/Content size | ? | ? | ? | ? | ? |
| Status page | ? | ? | ? | ? | ? |
| Suggestion box: source code to add | visitor & contributor | ? | 3 (easier to edit and see who edited the page) | ? | medium |
| Suggestion box: source code to add/Debian derivatives | visitor & contributor | ? | ? | ? | ? |
| Suggestion box: source code to add/KDE | visitor & contributor | ? | ? | ? | ? |
| Talks | visitor | Publications on site? | 1 ? | add link to annex | high |
| 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 page | for who (visitor/user/contributor) | can be attached to another page? | category (1/2/3) | possible solution | maintenance frequency |
|---|---|---|---|---|---|
| Arcanist | contributor (git only) | ? | 2 (done) | ? | ? |
| Arcanist setup | contributor (git only) | ? | 2 (done) | ? | ? |
| Code review | contributor (dev only) | ? | 2 (done) | ? | ? |
| Code review in Phabricator | contributor (dev only) | ? | 2 (done) | ? | ? |
| Continuous Integration | contributor (dev only) | ? | ? | ? | ? |
| Continuous integration | contributor (dev only) | ? | ? | ? | ? |
| Differential | contributor | ? | 4 (empty) | ? | ? |
| Forge | sysadmin (and contributor?) | ? | 4 (redirect to almost-empty page) | ? | ? |
| Git | contributor (git only) | ? | 4 (orphan + almost empty) | ? | ? |
| Git repositories | contributor (git only) | ? | 4 (orphan + almost empty) | ? | ? |
| Git style guide | contributor (git only) | ? | 2 (done) | ? | ? |
| HedgeDoc | ? | ? | ? | ? | ? |
| IRC | everyone | ? | ? | ? | ? |
| IRC channels | everyone | ? | ? | ? | ? |
| Jenkins | contributor (git only) | ? | ? | ? | ? |
| Mailing lists | everyone | ? | ? | ? | ? |
| Phabricator | sysadmin (and contributor?) | ? | move to intranet | ? | ? |
| Phabricator callsign naming convention | contributor | ? | ? | ? | ? |
| Private wiki | contributor | ? | ? | ? | ? |
| Public wiki | everyone | ? | ? | ? | ? |
| Report issues on phabricator | user | ? | ? | ? | ? |
| Wiki | ? | ? | 3 (it's about the wiki itself) | ? | ? |
| Wiki editing conventions | contributor | ? | 3 (it's about the wiki itself) | ? | ? |
bibliography + pages about other organizations/projects
pages about working groups
| wiki page | for who (visitor/user/contributor) | can be attached to another page? | category (1/2/3) | possible solution | maintenance frequency |
|---|---|---|---|---|---|
| Distribution Replication and Query | contributor | ? | ? | ? | ? |
| Ethical and Legal Issues and Environment | ? | ? | ? | ? | ? |
| Metadata and Linked Data | ? | ? | ? | ? | |
| Modeling and Ingesting Version control systems | contributor | ? | ? | ? | ? |
| Open Access and Data | ? | ? | ? | ? | ? |
| Process | ? | ? | ? | ? | ? |
| Reproducibility of Software | ? | ? | ? | ? | ? |
| Scientific API | ? | ? | ? | ? | ? |
| Source Discovery and Ingestion | ? | ? | ? | ? | ? |
| WG/Distribution Replication and Query | ? | ? | ? | ? | ? |
| WG/Ethical and Legal Issues and Environment | ? | ? | ? | ? | ? |
| WG/Metadata and Linked Data | ? | ? | ? | ? | ? |
| WG/Modeling and Ingesting Version control systems | ? | ? | ? | ? | ? |
| WG/Open Access and Data | ? | ? | ? | ? | ? |
| WG/Reproducibility of Software | ? | ? | ? | ? | ? |
| WG/Scientific API | ? | ? | ? | ? | ? |
| WG/Source Discovery and Ingestion | ? | ? | ? | ? | ? |
| Working Group Process | ? | ? | ? | ? | ? |
| Working group process | ? | ? | ? | ? | ? |
| Working groups | ? | ? | ? | ? | ? |
pages about non-public resources / infra
| wiki page | for who (visitor/user/contributor) | can be attached to another page? | category (1/2/3) | possible solution | maintenance frequency |
|---|---|---|---|---|---|
| Ceph Cluster | sysadmin | ? | ? | ? | ? |
| Dell MD3460 | sysadmin | ? | ? | ? | ? |
| Intranet | ? | ? | ? | ? | ? |
| Libvirt Disk Configuration | sysadmin | ? | ? | ? | ? |
| Puppet setup | sysadmin | ? | ? | ? | ? |
| Streaming Replication | sysadmin | ? | 4 (already moved) | ? | ? |
| New machine setup | sysadmin | ? | ? | ? | ? |
| VPN | contributor | ? | ? | ? | ? |
| Softwareheritage-ca.crt | contributor | ? | ? | ? | ? |
internship pages
Migrated from T3035 (view on Phabricator)
Edited by Phabricator Migration user