add toc and include the status page
|Deletions are marked like this.||Additions are marked like this.|
|Line 2:||Line 2:|
|Line 5:||Line 7:|
|See [[Services/Debian manpages archive]] for the [[Services]] survey page.||<<Include(Services/Debian manpages archive)>>|
https://manpages.debian.org/ is a service providing online manpages in HTML format for the public.
Debian manpages archive
Service Name: Debian manpages archive
Service URI: https://manpages.debian.org/
Service Short Description: Tool to search for man pages in the different Debian releases
Service Documentation: manpages.debian.org
Source Code: https://github.com/Debian/debiman
Service Status : active
Service hosting: debian.org
There are three known implementations of "man to web" archive generators.
The current codebase is a set of Perl and bash CGI scripts that dynamically generate (and search through) manpages.
A new codebase written by dgilman is available in github. It is a simple Python script with a sqlite backend.
The Minimum Viable Product for this project is a service that creates an HTML version of all the manpages of all the packages available in Debian, for all supported suites (including LTS).
A possible design would be:
1. fetch all manpages from the archive, store them on disk (makes them usable for tools like dman that browses remote webpages) 2. convert manpages to HTML so they are readable in a web browser 3. index HTML pages in a search engine of some sort
parts 1 and 2 would be generated on some VM and stored on manziarly (see below). parts 3 would be a separate (pair or?) server(s?) to run the search cluster.
the above could be formalized as patches to the dsa-puppet manifests.
1. write the MVP, maybe based on David's work 2. ask (through a rt.debian.org ticket) access to the manpages group 3. deploy a first dump of the manpages there 4. make a puppet manifest or document how to deploy the scripts 5. ask DSA to deploy the new code, test 6. if it works, fix the manpages.debian.org DNS to point to the static.d.o DNS. at this point, the MVP is in place 7. make search work...
The old service used to run on glinka.debian.org. Teams/DSA requested the service should be moved to manziarly.debian.org.
manziarly is the master server for static file servers in the Debian.org infrastructure. Files saved there are rsync'd to multiple frontend servers. How this is configured is detailed in the static-mirroring DSA documentation, but basically, we would need to ask the DSA team for an extra entry for manpages.d.o there to server static files.
Discussions about manpages.debian.org can take place on the regular Teams/DDP channels, for example the #debian-doc IRC channel and email@example.com mailing list.
You can also subscribe to this wiki page to get updates, which also functions as a ad-hoc forum.