[Nut-upsdev] Documentation inside git

[Jim Klimov]

The pieces should all be there, I think.

NUT source iterations cooperate with the sister nut-website repo on github,
as well as nut-ddl and some more, to produce an horde of static HTML pages,
and PDF versions of some docs, tarballs, etc. which are pushed to a repo
for "github pages" and with their magic (I guess GH spins up a container
with a web server and many data files for each new commit on this pages
repo) they become a browsable statically rendered site, as Greg outlined.

A model case for "browsable" PDF files embedded here are NUT's User and
Developer manuals, or the Changelog.

Likewise, a couple of years back we made Roger's book sources into a GitHub
repo (should be complete with a Makefile to render it, don't quite remember
if I had any further CI to react to commits or tagged releases, or I built
the PDFs locally and uploaded as release artifacts), and it was updated a
couple of times since.

So maybe the quest is about changing the link style from the nut-website
renditions to the book's PDF, so it would by default open in the same tab?

Currently commuting so can't say more at the moment.

Jim

On Mon, Jun 3, 2024, 02:21 Greg Troxel via Nut-upsdev <
nut-upsdev at alioth-lists.debian.net> wrote:

> Roger Price <roger at rogerprice.org> writes:
>
> > On Sun, 2 Jun 2024, Jim Klimov wrote:
> >
> >> Trying to remember the context: is your book only rendered as a PDF
> >> (a "release" of which on GitHub the NUT site currently points to),
> >> or are there also HTML renditions to point to this way (to see in a
> >> typical browser)?
> >
> > Sorry, I did not express myself clearly.  The book is in PDF, but PDF
> > can be displayed as if it were HTML by browsers such as Firefox and
> > Opera.  These browsers and maybe others are capable of treating PDF
> > just like it was HTML and providing an immediate display.
>
> Not really, but they will run a js program to render pdf.  Which means
> the user sees it, similar to html, so I see your point.
>
> > I would like to have an immediate display of the book from the NUT
> > website rather than from my own.  I think it's better to point
> > visitors to our official site rather than a personal site.  Also, NUT
> > will around a lot longer than me and my site, and maybe the book would
> > still be usefull.
>
> I think it still needs a CI rule to build the pdf and put it on github
> pages, or some other way to get it on whatever networkupstools.org is,
> and for that I think we'll need to wait for Jim.
>
> _______________________________________________
> Nut-upsdev mailing list
> Nut-upsdev at alioth-lists.debian.net
> https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/nut-upsdev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/nut-upsdev/attachments/20240603/891691d2/attachment.htm>