Differences between revisions 27 and 33 (spanning 6 versions)
Revision 27 as of 2016-12-04 23:32:24
Size: 2526
Comment: Update status
Revision 33 as of 2019-10-16 09:45:06
Size: 1142
Comment: Add information on how to report issues
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
https://manpages.debian.org/ is a service providing online manpages in HTML format for the public. https://manpages.debian.org/ is a service providing online manual pages for all Debian releases in HTML format for the public.
Line 7: Line 7:
<<Include(Services/Debian manpages archive,,editlink)>> <<Include(Services/Debian manpages archive,,from="=$",editlink)>>
Line 9: Line 9:
== Current implementation == = Deployment =
Line 11: Line 11:
The current `manpages.debian.org` service is a simple Perl CGI script running on manziarly.debian.org. This script searches within an archive that is generated through another set of scripts. The source code is available in http://anonscm.debian.org/viewvc/ddp/man-cgi/ The current `manpages.debian.org` service is powered by [[https://github.com/Debian/debiman|debiman]], running on `manziarly.debian.org`.
Line 13: Line 13:
In the past (when running in glinka.debian.org) this service was disabled by [[Teams/DSA]] several times because of performance issues. Even though the service has been modified to improve caching (on memory and on disk) it still was getting hit hard by robots that request Apache manpages. This excessive traffic is generated as many default Apache installations in Debian include links to these manpages (see http://bugs.debian.org/821313). Details on how to make changes to the site are in the [[https://manpages.debian.org/faq.html|FAQ]].
Line 15: Line 15:
The last time it was disabled was in August 2016, and remain in that state until it was re-activated in December 2016. = Issues =
Line 17: Line 17:
== New implementation ==

The current codebase is being rewritten from scratch by TheAnarcat into a package called [[https://debmans.readthedocs.io/en/latest/|Debmans]]. See the [[https://debmans.readthedocs.io/en/latest/design.html|design document]] for a discussion on the implementation.

At this point, the debmans code can extract all files from a mirror efficiently and convert them to HTML. It has not been tested on a full mirror yet, because TheAnarcat is waiting for `manpages` group access and dependencies install (`setuptools` from backports and/or `python-click`, `python-apt` and `python-debian`) in manzarly. See the [[https://debmans.readthedocs.io/en/latest/todo.html|TODO]] file for more information about the current status of the project and limitations.

For Debian maintainers not wishing to operate on the [[https://gitlab.com/anarcat/debmans|Gitlab platform]], there is also a [[https://anonscm.debian.org/git/collab-maint/debmans.git|collab-maint repository]] that is synchronised with Gitlab every hour.

= Hardware =

The service is running in `manziarly.debian.org`. It used to run on `glinka.debian.org`.
Issues can be reported directly in [[https://github.com/Debian/debiman/issues]]. There is also a virtual package `manpages.debian.org` in the Debian bug tracking system which can be used to report bugs: [[http://bugs.debian.org/manpages.debian.org]]
Line 31: Line 21:
Discussions about manpages.debian.org can take place on the regular [[Teams/DDP]] channels, for example the `#debian-doc` IRC channel and `debian-doc@lists.debian.org` mailing list. Discussions about manpages.debian.org takes place on the regular [[Teams/DDP]] channels, for example the `#debian-doc` IRC channel and `debian-doc@lists.debian.org` mailing list. If you have any question on the service please use these regular channels.

https://manpages.debian.org/ is a service providing online manual pages for all Debian releases in HTML format for the public.

Current status

Deployment

The current manpages.debian.org service is powered by debiman, running on manziarly.debian.org.

Details on how to make changes to the site are in the FAQ.

Issues

Issues can be reported directly in https://github.com/Debian/debiman/issues. There is also a virtual package manpages.debian.org in the Debian bug tracking system which can be used to report bugs: http://bugs.debian.org/manpages.debian.org

Forum

Discussions about manpages.debian.org takes place on the regular Teams/DDP channels, for example the #debian-doc IRC channel and debian-doc@lists.debian.org mailing list. If you have any question on the service please use these regular channels.

You can also subscribe to this wiki page to get updates, which also functions as an ad-hoc forum.