From a3cf49f4c54f450658ea340c550c4a79b571b730 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 11 Apr 2019 15:30:25 -0400 Subject: [PATCH 1/3] Replace the README.rst with a Markdown file, add badges for documentation status --- README.md | 25 +++++++++++++++++++++++++ README.rst | 26 -------------------------- 2 files changed, 25 insertions(+), 26 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 000000000..099daf883 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# xCAT + +xCAT is a toolkit for deployment and administration of clusters of all sizes. + +# Documentation + +xCAT Documentation is hosted on Read The Docs: https://xcat-docs.readthedocs.io + +## Status + +| xCAT Version | Build Status | +|---|---| +| Latest (master branch) | [![Documentation Status](https://readthedocs.org/projects/xcat-docs/badge/?version=latest)](https://xcat-docs.readthedocs.io/en/latest/) | +| Stable (latest release) | [![Documentation Status](https://readthedocs.org/projects/xcat-docs/badge/?version=stable)](https://xcat-docs.readthedocs.io/en/stable/) | + +Looking for [older versions](https://readthedocs.org/projects/xcat-docs/versions/)? + +# Open Source License + +xCAT is made available under the EPL license: https://opensource.org/licenses/eclipse-1.0.php + +# Developers + +Want to help? Check out the [developers guide](http://xcat-docs.readthedocs.io/en/latest/developers)! + diff --git a/README.rst b/README.rst deleted file mode 100644 index 36d9cfc0c..000000000 --- a/README.rst +++ /dev/null @@ -1,26 +0,0 @@ -xCAT ----- - -xCAT is a toolkit for the deployment and administration of clusters. - -Documentation -------------- - -`The stable documentation of xCAT `_ - -`The latest documentation of xCAT `_ - -`The documentation of xCAT each release `_ - - -Open Source License -------------------- - -xCAT is made available as open source software under the EPL license: -http://www.opensource.org/licenses/eclipse-1.0.php - -Developers ----------- - -Developers and prospective contributors are encouraged to read the `Developers Guide `_ -In particular the `GitHub `_ related subsection. From 8251a32bdb37609943117d7f070e137626d64ae2 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 11 Apr 2019 15:34:32 -0400 Subject: [PATCH 2/3] Update the README under the docs directory --- docs/README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8b4779eaf..c15ea02a1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,14 +1,12 @@ # Welcome to the xCAT documentation -The latest docs are here: http://xcat-docs.readthedocs.io/en/latest/ +The xCAT docs are hosted here: https://xcat-docs.readthedocs.io/ and are written in reStructuredText (`.rst`). -The documentation project is written in restructured text (.rst) using Sphinx and hosted on ReadTheDocs. +## Building docs locally -## Building Documentation +* Clone this project -* Clone the project - -* Using pip, install or update sphinx (See: http://pip.readthedocs.org/) +* Install or update sphinx (See: https://pip.readthedocs.io/) ``` pip install sphinx ``` @@ -17,15 +15,15 @@ The documentation project is written in restructured text (.rst) using Sphinx an pip install sphinx --upgrade ``` -* Using pip, install ReadTheDocs theme +* Install ReadTheDocs theme ``` pip install sphinx_rtd_theme ``` * Build the Docs ``` - cd xcat-core/docs - make html + 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 +* View the documentation by pointing a browser to: `xcat-core/docs/build/html/index.html` From f4d291954b38ab45299bd4cd17b47408dd752c9a Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 11 Apr 2019 15:35:54 -0400 Subject: [PATCH 3/3] Some additional formatting in the README --- docs/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index c15ea02a1..3c105885e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,17 +2,17 @@ The xCAT docs are hosted here: https://xcat-docs.readthedocs.io/ and are written in reStructuredText (`.rst`). -## Building docs locally +## Building Docs * Clone this project * Install or update sphinx (See: https://pip.readthedocs.io/) ``` - pip install sphinx + pip install sphinx ``` or ``` - pip install sphinx --upgrade + pip install sphinx --upgrade ``` * Install ReadTheDocs theme