After discussion the following structure emerged as proposal for the sysadm pages. After
the sprint, the arborescence evolved a bit but the gist of it remains. We want to
migrate the existing intranet pages to the sphinx instance.
A new page [1] to add the documentation site. This could be publicly linked from the
main page [2] (or not). This will be publicly exposed as other repositories already
exposed the same kind of information anyway (source code repositories, puppet, ...).
[1] https://docs.softwareheritage.org/sysadm/
[2] https://docs.softwareheritage.org/
- Getting started
- [x] [Puppet setup](https://intranet.softwareheritage.org/wiki/Puppet_setup)
- [x] [Making my first change in puppet](https://docs.softwareheritage.org/sysadm/puppet/tutorial-my-first-change-in-puppet.html)
- [x] [How to manage third-party modules](https://docs.softwareheritage.org/sysadm/puppet/howto-manage-third-party-modules.html)
- [x] [How to deploy a puppet change](https://docs.softwareheritage.org/sysadm/puppet/howto-deploy-puppet-change.html)
- [ ] Check puppet manifests with vagranta
- [ ] Provision new vms
- [x] [Access to the Credential store](https://intranet.softwareheritage.org/wiki/Credential_storage)
- [ ] link to the phabricator tuto in devel doc
- ...
- How to
- [x] [Debian packaging](https://wiki.softwareheritage.org/wiki/Debian_packaging) (could be cross-linked maybe)
- [x] [Database upgrade](https://intranet.softwareheritage.org/wiki/Upgrades)
- [ ] Database deployment
- [ ] Deploy a new swh module in staging/production
- [x] [Upgrade swh service](https://docs.softwareheritage.org/sysadm/deployment/upgrade-swh-service.html)
- [x] [Deploying a lister](https://intranet.softwareheritage.org/wiki/Deploying_a_lister)
- [x] [Keycloak](https://intranet.softwareheritage.org/wiki/Keycloak)
- [x] [Connect to a database](https://intranet.softwareheritage.org/wiki/Databases)
- [x] [Onboarding](https://intranet.softwareheritage.org/wiki/Onboarding)
- [x] [Outboarding](https://intranet.softwareheritage.org/wiki/Outboarding)
- Explanation
- Infrastructure
- [ ] Production
- [x] [Staging environment](https://intranet.softwareheritage.org/wiki/Staging_environment)
- [ ] [Network configuration](https://intranet.softwareheritage.org/wiki/Network_configuration)
- [ ] Source of truth -> Inventory
# Pros/cons
## pros
- code review ahead of time available (one could always skip it if they don't want to)
- tool unification (sphinx rst, git, ...)
## cons
No cons that I can see (well the migration per say but that can be done incrementally :)
# Remaining pages to redispatch eventually
- [ ] [Backups](https://intranet.softwareheritage.org/wiki/Backups)
- [ ] [Database inventory](https://intranet.softwareheritage.org/wiki/Databases_inventory)
- [x] [IDRAC](https://intranet.softwareheritage.org/wiki/IDRAC) (credentials moved to credential store first)
- [x] [Jenkins](https://wiki.softwareheritage.org/wiki/Jenkins) -> actually to devel docs
- [ ] [IRC](https://wiki.softwareheritage.org/wiki/IRC)
- [ ] [Pglogical replication](https://intranet.softwareheritage.org/wiki/Pglogical_replication)
- ...