Now that we can create a (almost correct) bunch of HTML documents with our apidoc, we need to publish it somewhere.
The ideal URL would be something like https://www.softwareheritage.org/devel/docs/ . That will probably be a reverse proxy/redirect to somewhere else.
We need to figure out that "somewhere else" and the update process.
| Status | Assigned | Task | ||
|---|---|---|---|---|
| Migrated | gitlab-migration | T509 Generate and publish Software Heritage Development Documentation | ||
| Migrated | gitlab-migration | T750 publish static HTML version of the Software Heritage development documentation |
Gandi simple hosting unfortunately does not have apache's mod_proxy and, more generally, any way to do reverse proxying (short of doing that in wordpress, which is horrible).
So let's go for something like docs.softwareheritage.org, and serve the development documentation from there starting at /devel.
I've prepared (but not committed yet) the puppet changes needed to serve docs.s.o from pergamon, and I'm going to add "docs" as a CNAME on the Gandi DNS.
If you've feedback on this plan, this is the time :-)