Announce: manpages as html in a container
Hi, since the beginning has openSUSE MicroOS one deficit: documentation will not be installed. For standard commands this is no problem: you can read the manpages on Tumbleweed, Leap, ... or other distributions or web pages. But for some MicroOS specific tools this is no option. Back in the "good old times" some decades ago Sun had something I really liked: a documentation server serving all documentation, which you could also install on the local network. This is what I always wanted to have for openSUSE, too :) Now here it is, start your own MicroOS documentation server: podman run -it --rm --name docserv -p 80:80 -p 443:443 opensuse/microos-docserv and connect as http://localhost or https://localhost with your webbrowser to browse, search and read our manual pages. The next goal is, to not only provide a container with the manual pages for MicroOS, but something like "manpages.opensuse.org" containing all manpages from openSUSE Tumbleweed! But for this help is needed: 1. Working style sheet Alexandre was so nice and created something for the start. But this needs more testing and bug fixing, especially the mobile support. 2. Generate somehow the data for the webpages We need access to a full tree of openSUSE Tumbleweed, generate the data and upload it to a webserver 3. manpages.opensuse.org We need that sub-domain, and a machine serving the data 4. Integrate additional documentation How can we integrate other docu? texinfo? HTML docu? Every help is welcome and needed for testing, development, integration. The github repo is https://github.com/thkukuk/rpm2docserv Packages and the container description are already part of Tumbleweed. The whole idea and parts of the code are based on the debiman project from Debian. Thorsten -- Thorsten Kukuk, Distinguished Engineer, Senior Architect SUSE Software Solutions Germany GmbH, Frankenstraße 146, 90461 Nuernberg, Germany Managing Director: Ivo Totev, Andrew Myers, Andrew McDonald, Martje Boudien Moerman (HRB 36809, AG Nürnberg)
------- Original Message ------- On Tuesday, September 27th, 2022 at 9:56 AM, Thorsten Kukuk <kukuk@suse.com> wrote:
Hi,
since the beginning has openSUSE MicroOS one deficit: documentation will not be installed. For standard commands this is no problem: you can read the manpages on Tumbleweed, Leap, ... or other distributions or web pages. But for some MicroOS specific tools this is no option.
Back in the "good old times" some decades ago Sun had something I really liked: a documentation server serving all documentation, which you could also install on the local network. This is what I always wanted to have for openSUSE, too :)
Now here it is, start your own MicroOS documentation server:
podman run -it --rm --name docserv -p 80:80 -p 443:443 opensuse/microos-docserv
and connect as http://localhost or https://localhost with your webbrowser to browse, search and read our manual pages.
The next goal is, to not only provide a container with the manual pages for MicroOS, but something like "manpages.opensuse.org" containing all manpages from openSUSE Tumbleweed!
But for this help is needed:
1. Working style sheet Alexandre was so nice and created something for the start. But this needs more testing and bug fixing, especially the mobile support.
2. Generate somehow the data for the webpages We need access to a full tree of openSUSE Tumbleweed, generate the data and upload it to a webserver
3. manpages.opensuse.org We need that sub-domain, and a machine serving the data
4. Integrate additional documentation How can we integrate other docu? texinfo? HTML docu?
Every help is welcome and needed for testing, development, integration.
The github repo is https://github.com/thkukuk/rpm2docserv Packages and the container description are already part of Tumbleweed.
The whole idea and parts of the code are based on the debiman project from Debian.
Thorsten
-- Thorsten Kukuk, Distinguished Engineer, Senior Architect SUSE Software Solutions Germany GmbH, Frankenstraße 146, 90461 Nuernberg, Germany Managing Director: Ivo Totev, Andrew Myers, Andrew McDonald, Martje Boudien Moerman (HRB 36809, AG Nürnberg)
This is an awesome project! Going to look into where I can help you once I get some free time <3 Br, A.
participants (2)
-
Attila Pinter -
Thorsten Kukuk