mirror of
https://github.com/xcat2/xcat-core.git
synced 2026-09-24 16:54:03 +00:00
Vinícius Ferrão
e654de5c4a
The project had no written release process, and the 2.18 and 2.19 releases missed steps: the release table in the documentation, the docs version, signed tags, and the wiki and website index pages. A new Releases section describes the branch and version model, the label and milestone that each pull request needs, and a checklist for release candidates, publishing, the signed tag, the GitHub release, the release notes, the website and the announcement. The build hosts, the signing key and the publish procedure stay in the private repository of the maintainers.
Welcome to the xCAT documentation
The xCAT docs are hosted here: https://xcat-docs.readthedocs.io/ and are written in reStructuredText (.rst).
Building Docs
-
Clone this project
-
Install dependencies (See: https://pip.readthedocs.io/)
pip install --user -r requirements.txt -
Build the Docs
cd xcat-core/docs make html -
View the documentation by pointing a browser to:
xcat-core/docs/build/html/index.html