[Rpm-maint] [rpm-software-management/rpm] Doc Rework (#1679)

Florian Festi notifications at github.com
Fri May 7 15:24:05 UTC 2021


This is an attempt to solve #1666. We have some documentation on https://rpm.org that lives in the `rpm-web` repo and the docs in `doc/manual` that should stay in the sources repo. Currently these are duplicated and can't be kept in sync easily.

These cahnges re-arange the files so `docs/manual` (sic!) can be rendered as GitHub pages - just as rpm.org. Using the same `_layout` would allow just binding the two GH pages together with links and have them work nearly seamlessly together.

Unfortunately GH pages does not support `doc/` as a location - only `docs` *sigh*
Preview of the result can be seen in the GH pages of my private repository: http://ffesti.github.io/rpm/manual/

I would like to also find a way to have the man pages rendered, too.
We might consider pushing some of these changes out after 4.17 forks away as so many files moving around between alpha and the release is kinda arkward.
You can view, comment on, or merge this pull request online at:

  https://github.com/rpm-software-management/rpm/pull/1679

-- Commit Summary --

  * Rename doc/ to docs/ to work with GitHub Pages
  * Move man pages into their own sub directory
  * Add layout for adding manual/ to Github pages
  * Reference Manual: Re-arrange index

-- File Changes --

    M Makefile.am (20)
    M configure.ac (3)
    A docs/Makefile.am (34)
    A docs/_layouts/default.html (60)
    R docs/librpm.doxy.in (6)
    R docs/librpm/Doxyheader.h (0)
    R docs/man/Makefile.am (30)
    R docs/man/fr/rpm.8 (0)
    R docs/man/gendiff.1 (0)
    R docs/man/ja/rpm.8 (0)
    R docs/man/ja/rpm2cpio.8 (0)
    R docs/man/ja/rpmbuild.8 (0)
    R docs/man/ja/rpmgraph.8 (0)
    R docs/man/ko/rpm.8 (0)
    R docs/man/ko/rpm2cpio.8 (0)
    R docs/man/pl/gendiff.1 (0)
    R docs/man/pl/rpm.8 (0)
    R docs/man/pl/rpm2cpio.8 (0)
    R docs/man/pl/rpmbuild.8 (0)
    R docs/man/pl/rpmdeps.8 (0)
    R docs/man/pl/rpmgraph.8 (0)
    R docs/man/rpm-misc.8 (0)
    R docs/man/rpm-plugin-audit.8 (0)
    R docs/man/rpm-plugin-fapolicyd.8 (0)
    R docs/man/rpm-plugin-ima.8 (0)
    R docs/man/rpm-plugin-prioreset.8 (0)
    R docs/man/rpm-plugin-selinux.8 (0)
    R docs/man/rpm-plugin-syslog.8 (0)
    R docs/man/rpm-plugin-systemd-inhibit.8 (0)
    R docs/man/rpm-plugins.8 (0)
    R docs/man/rpm.8 (0)
    R docs/man/rpm2archive.8 (0)
    R docs/man/rpm2cpio.8 (0)
    R docs/man/rpmbuild.8 (0)
    R docs/man/rpmdb.8 (0)
    R docs/man/rpmdeps.8 (0)
    R docs/man/rpmgraph.8 (0)
    R docs/man/rpmkeys.8 (0)
    R docs/man/rpmsign.8 (0)
    R docs/man/rpmspec.8 (0)
    R docs/man/ru/rpm.8 (0)
    R docs/man/ru/rpm2cpio.8 (0)
    R docs/man/sk/rpm.8 (0)
    R docs/manual/arch_dependencies.md (6)
    R docs/manual/autosetup.md (4)
    R docs/manual/boolean_dependencies.md (4)
    R docs/manual/buildprocess.md (4)
    R docs/manual/buildroot.md (4)
    R docs/manual/conditionalbuilds.md (4)
    R docs/manual/dependencies.md (4)
    R docs/manual/dependency_generators.md (4)
    R docs/manual/file_triggers.md (5)
    R docs/manual/format.md (4)
    R docs/manual/hregions.md (4)
    R docs/manual/index.md (19)
    R docs/manual/large_files.md (0)
    R docs/manual/lua.md (4)
    R docs/manual/macros.md (4)
    R docs/manual/more_dependencies.md (4)
    R docs/manual/multiplebuilds.md (4)
    R docs/manual/plugins.md (0)
    R docs/manual/queryformat.md (4)
    R docs/manual/relocatable.md (4)
    R docs/manual/scriptlet_expansion.md (4)
    R docs/manual/signatures.md (4)
    R docs/manual/signatures_digests.md (4)
    R docs/manual/spec.md (4)
    R docs/manual/tags.md (4)
    R docs/manual/triggers.md (4)
    R docs/manual/tsort.md (4)

-- Patch Links --

https://github.com/rpm-software-management/rpm/pull/1679.patch
https://github.com/rpm-software-management/rpm/pull/1679.diff

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/1679
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rpm.org/pipermail/rpm-maint/attachments/20210507/3a908d51/attachment-0001.html>


More information about the Rpm-maint mailing list