diff --git a/docs/source/index.rst b/docs/source/index.rst index d507a22b7..0afdb7281 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -32,6 +32,7 @@ Table of Contents guides/install-guides/index.rst guides/admin-guides/index.rst advanced/index.rst + references/index.rst troubleshooting/index.rst developers/index.rst help.rst diff --git a/docs/source/references/coral/discovery/compute/index.rst b/docs/source/references/coral/discovery/compute/index.rst new file mode 100644 index 000000000..f685c63b8 --- /dev/null +++ b/docs/source/references/coral/discovery/compute/index.rst @@ -0,0 +1,9 @@ +Compute Nodes +============= + +.. toctree:: + :maxdepth: 2 + + discover.rst + validation.rst + diff --git a/docs/source/references/coral/discovery/core_sw/index.rst b/docs/source/references/coral/discovery/core_sw/index.rst new file mode 100644 index 000000000..725a8776c --- /dev/null +++ b/docs/source/references/coral/discovery/core_sw/index.rst @@ -0,0 +1,2 @@ +Core Switches +============= diff --git a/docs/source/references/coral/discovery/edge_sw/index.rst b/docs/source/references/coral/discovery/edge_sw/index.rst new file mode 100644 index 000000000..557313161 --- /dev/null +++ b/docs/source/references/coral/discovery/edge_sw/index.rst @@ -0,0 +1,2 @@ +Edge Switches +============= diff --git a/docs/source/references/coral/discovery/index.rst b/docs/source/references/coral/discovery/index.rst new file mode 100644 index 000000000..3d7984876 --- /dev/null +++ b/docs/source/references/coral/discovery/index.rst @@ -0,0 +1,13 @@ +Discovery +========= + +.. toctree:: + :maxdepth: 2 + + core_sw/index.rst + mgmt_sw/index.rst + mid_sw/index.rst + servicenode/index.rst + edge_sw/index.rst + compute/index.rst + diff --git a/docs/source/references/coral/discovery/mgmt_sw/index.rst b/docs/source/references/coral/discovery/mgmt_sw/index.rst new file mode 100644 index 000000000..57bc8d2ec --- /dev/null +++ b/docs/source/references/coral/discovery/mgmt_sw/index.rst @@ -0,0 +1,2 @@ +Management Switches +=================== diff --git a/docs/source/references/coral/discovery/mid_sw/index.rst b/docs/source/references/coral/discovery/mid_sw/index.rst new file mode 100644 index 000000000..8ef8bdacc --- /dev/null +++ b/docs/source/references/coral/discovery/mid_sw/index.rst @@ -0,0 +1,2 @@ +Mid Switches +============ diff --git a/docs/source/references/coral/discovery/servicenode/index.rst b/docs/source/references/coral/discovery/servicenode/index.rst new file mode 100644 index 000000000..23ff6169e --- /dev/null +++ b/docs/source/references/coral/discovery/servicenode/index.rst @@ -0,0 +1,9 @@ +Service Nodes +============= + +.. toctree:: + :maxdepth: 2 + + discover.rst + validation.rst + diff --git a/docs/source/references/coral/index.rst b/docs/source/references/coral/index.rst new file mode 100644 index 000000000..e95fca989 --- /dev/null +++ b/docs/source/references/coral/index.rst @@ -0,0 +1,9 @@ +CORAL +===== + +.. toctree:: + :maxdepth: 4 + + mn/index.rst + discovery/index.rst + diff --git a/docs/source/references/coral/mn/configure/index.rst b/docs/source/references/coral/mn/configure/index.rst new file mode 100644 index 000000000..801000b83 --- /dev/null +++ b/docs/source/references/coral/mn/configure/index.rst @@ -0,0 +1,5 @@ +Configure +========= + +.. toctree:: + :maxdepth: 2 diff --git a/docs/source/references/coral/mn/index.rst b/docs/source/references/coral/mn/index.rst new file mode 100644 index 000000000..426e330a6 --- /dev/null +++ b/docs/source/references/coral/mn/index.rst @@ -0,0 +1,12 @@ +Management Node - xCAT +====================== + +The Management Node should be installed with a RHEL Operating System. The following guides describe the process of installation, configuration and validation of xCAT on the Management Node. + +.. toctree:: + :maxdepth: 2 + + install.rst + configure/index.rst + validate/index.rst + diff --git a/docs/source/references/coral/mn/install.rst b/docs/source/references/coral/mn/install.rst new file mode 100644 index 000000000..87782b2f8 --- /dev/null +++ b/docs/source/references/coral/mn/install.rst @@ -0,0 +1,2 @@ +Install +======= diff --git a/docs/source/references/coral/mn/validate/index.rst b/docs/source/references/coral/mn/validate/index.rst new file mode 100644 index 000000000..8337700a0 --- /dev/null +++ b/docs/source/references/coral/mn/validate/index.rst @@ -0,0 +1,6 @@ +Validate +======== + +.. toctree:: + :maxdepth: 2 + diff --git a/docs/source/references/index.rst b/docs/source/references/index.rst new file mode 100644 index 000000000..3a5363335 --- /dev/null +++ b/docs/source/references/index.rst @@ -0,0 +1,9 @@ +Reference Implementation +======================== + +.. toctree:: + :maxdepth: 4 + + coral/index.rst + percs/index.rst + diff --git a/docs/source/references/percs/index.rst b/docs/source/references/percs/index.rst new file mode 100644 index 000000000..e60f08f29 --- /dev/null +++ b/docs/source/references/percs/index.rst @@ -0,0 +1,5 @@ +PERCS +===== + +See documentation here: https://sourceforge.net/p/xcat/wiki/XCAT_Power_775_Hardware_Management/ +