Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 801565 - appendices/: should have information how one can "compile" and test their work
Summary: appendices/: should have information how one can "compile" and test their work
Status: RESOLVED INVALID
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-07-11 11:02 UTC by Joonas Niilola
Modified: 2021-07-11 13:35 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Joonas Niilola gentoo-dev 2021-07-11 11:02:38 UTC
I couldn't find exact steps what I need to do in order to build and print my page locally as it would in https://devmanual.gentoo.org. So contributing a huge page is guesswork how it's going to end up in live.
https://devmanual.gentoo.org/appendices/contributing/index.html
https://devmanual.gentoo.org/appendices/contributing/index.html
Comment 1 Ulrich Müller gentoo-dev 2021-07-11 13:26:01 UTC
The steps should be listed there:
https://devmanual.gentoo.org/appendices/contributing/index.html#where-to-find-the-sources

"Where to find the sources

Currently, sources are hosted on git.gentoo.org. For current Gentoo developers, access is at git+ssh://git@git.gentoo.org/proj/devmanual.git. Non-developers can clone the repository by typing git clone git://anongit.gentoo.org/proj/devmanual.git. The sources are also hosted on GitHub for those who prefer to submit patches using pull requests. 

To build the devmanual, simply run make in the top directory of the repository. You need xsltproc (from dev-libs/libxslt) for the XML to HTML conversion, xmllint (from dev-libs/libxml2) for validation, and rsvg-convert (from gnome-base/librsvg) for the SVG to PNG conversion used in some of the figures throughout the document.

To check if the document's XML is valid, run make validate in the top-level directory, which will validate all XML files using xmllint."

Not enough?
Comment 2 Joonas Niilola gentoo-dev 2021-07-11 13:35:21 UTC
Well, this is a bit embarrassing. 

I'd add a subtopic, 
Where to find the sources
  -> How to build the sources

to make it more visible. Since, as proven, it can be missed while eyeballing through the document with only one thing in mind!

Yeah this is on me.