mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-06-18 04:10:46 +00:00
Item1: Change sentence: "A messages will be logged that you must use updatenode <noderange> -F to sync files using updatenode" to be "A message will be logged that you must use updatenode <noderange> -F to sync files"? Item2: Title “syncfiles to the nodes” to be “Syncfiles to the nodes” Item3: In "quickly fix the keys and credentials on your Service and compute nodes", change "Service" to be "service"?
Welcome to the xCAT documentation
We are working on improving the documentation. The latest docs are here: http://xcat-docs.readthedocs.org/en/latest/
The documentation project is written in restructured text (.rst) using Sphinx. To build the docs locally:
-
Clone the project
-
Using pip, install sphinx (See: http://pip.readthedocs.org/)
pip install sphinx
- Build the Docs
cd xcat-core/docs
make html
- View the docs by opening index.html from a web browser under xcat-core/docs/build/html/index.html