2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-22 03:32:04 +00:00
chenglch 25141161e5 Add man page for makegocons
This is the guide about how to make goconserver as
a replacement for conserver to help slove the issues reported
for conserver, like: #4043, #3543. For openbmc, the solution of
goconserver is much light-weighted than the conserver which could
help save the system resource. In addition, sshpass is not needed
for openbmc with goconserver.

Implement: #4337
2017-12-05 01:15:19 -05:00
..
2017-12-05 01:15:19 -05:00
2017-05-09 17:00:09 -04:00

Welcome to the xCAT documentation

The latest docs are here: http://xcat-docs.readthedocs.io/en/latest/

The documentation project is written in restructured text (.rst) using Sphinx and hosted on ReadTheDocs.

Building Documentation

  • Clone the project

  • Using pip, install or update sphinx (See: http://pip.readthedocs.org/)

     pip install sphinx  
    

    or

     pip install sphinx --upgrade 
    
  • Using pip, install ReadTheDocs theme

    pip install sphinx_rtd_theme
    
  • 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