diff --git a/doc/source/cli_ref/index.rst b/doc/source/cli_ref/index.rst new file mode 100644 index 000000000..2802039c0 --- /dev/null +++ b/doc/source/cli_ref/index.rst @@ -0,0 +1,12 @@ +============= +CLI Reference +============= + +This is a stub page for the topic: CLI Reference. You can help StarlingX by +expanding the content. + +See the story for additional information about what is needed: +`Add CLI Reference `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. \ No newline at end of file diff --git a/doc/source/configuration/brand_config.rst b/doc/source/configuration/brand_config.rst new file mode 100644 index 000000000..b798412ce --- /dev/null +++ b/doc/source/configuration/brand_config.rst @@ -0,0 +1,16 @@ +====================== +Branding Configuration +====================== + +This is a stub page for the topic: Branding Configuration. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Branding Config guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/configuration/cert_config.rst b/doc/source/configuration/cert_config.rst new file mode 100644 index 000000000..bcfb1404c --- /dev/null +++ b/doc/source/configuration/cert_config.rst @@ -0,0 +1,16 @@ +========================= +Certificate Configuration +========================= + +This is a stub page for the topic: Certificate Configuration. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Certificate Configuration and Management guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/configuration/host_config.rst b/doc/source/configuration/host_config.rst new file mode 100644 index 000000000..96d6e488a --- /dev/null +++ b/doc/source/configuration/host_config.rst @@ -0,0 +1,16 @@ +================== +Host Configuration +================== + +This is a stub page for the topic: Host Configuration. You can help StarlingX by +expanding the content. + +See the story for additional information about what is needed: +`Add Host Configuration Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst new file mode 100644 index 000000000..0f3a53222 --- /dev/null +++ b/doc/source/configuration/index.rst @@ -0,0 +1,36 @@ +============= +Configuration +============= + +--------------------- +General Configuration +--------------------- + +.. toctree:: + :maxdepth: 1 + + brand_config + cert_config + host_config + system_config + time_sync_config + +------------------------ +Kubernetes Configuration +------------------------ + +.. toctree:: + :maxdepth: 1 + + k8s_persistent_vol + +----------------------- +OpenStack Configuration +----------------------- + +.. toctree:: + :maxdepth: 1 + + openstack_ironic_config + openstack_swift_config + diff --git a/doc/source/configuration/k8s_persistent_vol.rst b/doc/source/configuration/k8s_persistent_vol.rst new file mode 100644 index 000000000..eac040aae --- /dev/null +++ b/doc/source/configuration/k8s_persistent_vol.rst @@ -0,0 +1,16 @@ +=============================== +Persistent Volume Configuration +=============================== + +This is a stub page for the topic: Configuring Persistent Volume Support. You +can help StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Kubernetes Persistent Volume Support Config Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/configuration/openstack_ironic_config.rst b/doc/source/configuration/openstack_ironic_config.rst new file mode 100644 index 000000000..9d06cfddc --- /dev/null +++ b/doc/source/configuration/openstack_ironic_config.rst @@ -0,0 +1,16 @@ +============================== +OpenStack Ironic Configuration +============================== + +This is a stub page for the topic: OpenStack Ironic Configuration and Management. +You can help StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add OpenStack Ironic Configuration and Management Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/configuration/openstack_swift_config.rst b/doc/source/configuration/openstack_swift_config.rst new file mode 100644 index 000000000..f6bb5e820 --- /dev/null +++ b/doc/source/configuration/openstack_swift_config.rst @@ -0,0 +1,16 @@ +============================= +OpenStack Swift Configuration +============================= + +This is a stub page for the topic: OpenStack Swift Configuration. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add OpenStack Swift Configuration and Management Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/configuration/system_config.rst b/doc/source/configuration/system_config.rst new file mode 100644 index 000000000..6ef176cf0 --- /dev/null +++ b/doc/source/configuration/system_config.rst @@ -0,0 +1,17 @@ +===================== +System Configuration +===================== + +This is a stub page for the topic: System Configuration. You can help StarlingX +by expanding the content. + +See the story for additional information about what is needed: +`Add System Configuration Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 + diff --git a/doc/source/configuration/time_sync_config.rst b/doc/source/configuration/time_sync_config.rst new file mode 100644 index 000000000..fb873a52a --- /dev/null +++ b/doc/source/configuration/time_sync_config.rst @@ -0,0 +1,16 @@ +================================== +Time Synchronization Configuration +================================== + +This is a stub page for the topic: Time Synchronization Configuration. You can +help StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Time Synchronization Configuration Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/deploy_install_guides/index.rst b/doc/source/deploy_install_guides/index.rst index dac0244b4..1c3eb522d 100755 --- a/doc/source/deploy_install_guides/index.rst +++ b/doc/source/deploy_install_guides/index.rst @@ -1,6 +1,6 @@ -================================== -Installation and Deployment Guides -================================== +=================== +Installation Guides +=================== Installation and deployment guides for StarlingX are release-specific. Each guide provides instruction on a specific StarlingX configuration diff --git a/doc/source/index.rst b/doc/source/index.rst index 74d419750..68bec51b5 100755 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -19,7 +19,10 @@ The documentation is organized into the following sections: introduction/index deploy_install_guides/index + configuration/index + operations/index api-ref/index + cli_ref/index contributor/index releasenotes/index developer_resources/index diff --git a/doc/source/operations/app_management.rst b/doc/source/operations/app_management.rst new file mode 100644 index 000000000..378e2668c --- /dev/null +++ b/doc/source/operations/app_management.rst @@ -0,0 +1,16 @@ +====================== +Application Management +====================== + +This is a stub page for the topic: Application Management. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Application Management Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/backup_restore_container.rst b/doc/source/operations/backup_restore_container.rst new file mode 100644 index 000000000..c9a16c90d --- /dev/null +++ b/doc/source/operations/backup_restore_container.rst @@ -0,0 +1,16 @@ +============================== +Backup/Restore with Containers +============================== + +This is a stub page for the topic: Backup/Restore with Containers. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Backup/Restore with Containers Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/controller_service_manage.rst b/doc/source/operations/controller_service_manage.rst new file mode 100644 index 000000000..8afd29d0c --- /dev/null +++ b/doc/source/operations/controller_service_manage.rst @@ -0,0 +1,16 @@ +============================== +Controller Services Management +============================== + +This is a stub page for the topic: Controller Services Management. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Controller Services Management Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/cpu_manager.rst b/doc/source/operations/cpu_manager.rst new file mode 100644 index 000000000..783978dc7 --- /dev/null +++ b/doc/source/operations/cpu_manager.rst @@ -0,0 +1,16 @@ +=========== +CPU Manager +=========== + +This is a stub page for the topic: CPU Manager. You can help StarlingX by +expanding the content. + +See the story for additional information about what is needed: +`Add CPU Manager Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/dedicate_cpu_container.rst b/doc/source/operations/dedicate_cpu_container.rst new file mode 100644 index 000000000..fa923be02 --- /dev/null +++ b/doc/source/operations/dedicate_cpu_container.rst @@ -0,0 +1,16 @@ +=========================== +Dedicate CPUs to Containers +=========================== + +This is a stub page for the topic: Dedicate CPUs to Containers. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Kubernetes Dedicate CPUs to Container Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/dist_cloud_management.rst b/doc/source/operations/dist_cloud_management.rst new file mode 100644 index 000000000..2b82ef179 --- /dev/null +++ b/doc/source/operations/dist_cloud_management.rst @@ -0,0 +1,16 @@ +============================ +Distributed Cloud Management +============================ + +This is a stub page for the topic: Distributed Cloud Management. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Distributed Cloud Management Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/fault_management.rst b/doc/source/operations/fault_management.rst new file mode 100644 index 000000000..70034644e --- /dev/null +++ b/doc/source/operations/fault_management.rst @@ -0,0 +1,16 @@ +================ +Fault Management +================ + +This is a stub page for the topic: Fault Management. You can help StarlingX by +expanding the content. + +See the story for additional information about what is needed: +`Add Fault Management Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/host_management.rst b/doc/source/operations/host_management.rst new file mode 100644 index 000000000..e05e5ce8b --- /dev/null +++ b/doc/source/operations/host_management.rst @@ -0,0 +1,16 @@ +=============== +Host Management +=============== + +This is a stub page for the topic: Host Management. You can help StarlingX by +expanding the content. + +See the story for additional information about what is needed: +`Add Host Management Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/index.rst b/doc/source/operations/index.rst new file mode 100644 index 000000000..feeb09447 --- /dev/null +++ b/doc/source/operations/index.rst @@ -0,0 +1,46 @@ +================ +Operation Guides +================ + +----------------- +General Operation +----------------- + +.. toctree:: + :maxdepth: 1 + + app_management + backup_restore_container + controller_service_manage + cpu_manager + dedicate_cpu_container + dist_cloud_management + fault_management + host_management + lldp_monitor + patching + storage_util_display + upgrade + +-------------------- +Kubernetes Operation +-------------------- + +.. toctree:: + :maxdepth: 1 + + k8s_cluster + k8s_docker_reg_management + k8s_persistent_vol_claims + k8s_sriov_config + +------------------- +OpenStack Operation +------------------- + +.. toctree:: + :maxdepth: 1 + + openstack_time_sensitive_networking + openstack_vm_pci_config + openstack_vm_sriov_config \ No newline at end of file diff --git a/doc/source/operations/k8s_cluster.rst b/doc/source/operations/k8s_cluster.rst new file mode 100644 index 000000000..2e2b54480 --- /dev/null +++ b/doc/source/operations/k8s_cluster.rst @@ -0,0 +1,16 @@ +======================== +Kubernetes Cluster Guide +======================== + +This is a stub page for the topic: Kubernetes Cluster Guide. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Kubernetes Cluster Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/k8s_docker_reg_management.rst b/doc/source/operations/k8s_docker_reg_management.rst new file mode 100644 index 000000000..d62b0a7ed --- /dev/null +++ b/doc/source/operations/k8s_docker_reg_management.rst @@ -0,0 +1,16 @@ +============================================= +Kubernetes Docker Registry Management (Local) +============================================= + +This is a stub page for the topic: Kubernetes Docker Registry Management (Local). You +can help StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Kubernetes Docker Registry Management (Local) Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/k8s_persistent_vol_claims.rst b/doc/source/operations/k8s_persistent_vol_claims.rst new file mode 100644 index 000000000..65f774755 --- /dev/null +++ b/doc/source/operations/k8s_persistent_vol_claims.rst @@ -0,0 +1,16 @@ +================================================= +Kubernetes Persistent Volume Claims in Containers +================================================= + +This is a stub page for the topic: Kubernetes Persistent Volume Claims in +Containers. You can help StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Kubernetes Persistent Volume Claims in Containers Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/k8s_sriov_config.rst b/doc/source/operations/k8s_sriov_config.rst new file mode 100644 index 000000000..3780c2b1d --- /dev/null +++ b/doc/source/operations/k8s_sriov_config.rst @@ -0,0 +1,16 @@ +======================================== +Kubernetes SRIOV Container Configuration +======================================== + +This is a stub page for the topic: Kubernetes SRIOV Container Configuration. You +can help StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Kubernetes SRIOV Container Configuration Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/lldp_monitor.rst b/doc/source/operations/lldp_monitor.rst new file mode 100644 index 000000000..100bdfda8 --- /dev/null +++ b/doc/source/operations/lldp_monitor.rst @@ -0,0 +1,16 @@ +=========================== +LLDP Monitoring and Display +=========================== + +This is a stub page for the topic: LLDP Monitoring and Display. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add LLDP Monitoring and Display Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/openstack_time_sensitive_networking.rst b/doc/source/operations/openstack_time_sensitive_networking.rst new file mode 100644 index 000000000..abd7b48e7 --- /dev/null +++ b/doc/source/operations/openstack_time_sensitive_networking.rst @@ -0,0 +1,16 @@ +=================================== +OpenStack Time Sensitive Networking +=================================== + +This is a stub page for the topic: OpenStack Time Sensitive Networking. You can +help StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Time Sensitive Networking Guide (OpenStack) `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/openstack_vm_pci_config.rst b/doc/source/operations/openstack_vm_pci_config.rst new file mode 100644 index 000000000..8110c6544 --- /dev/null +++ b/doc/source/operations/openstack_vm_pci_config.rst @@ -0,0 +1,16 @@ +============================================= +OpenStack VM Generic PCI Device Configuration +============================================= + +This is a stub page for the topic: OpenStack VM Generic PCI Device Configuration. +You can help StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add VM Generic PCI Device Configuration Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/openstack_vm_sriov_config.rst b/doc/source/operations/openstack_vm_sriov_config.rst new file mode 100644 index 000000000..bf499a1e3 --- /dev/null +++ b/doc/source/operations/openstack_vm_sriov_config.rst @@ -0,0 +1,16 @@ +========================================== +OpenStack VM SRIOV Interface Configuration +========================================== + +This is a stub page for the topic: OpenStack VM SRIOV Interface Configuration. +You can help StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add VM SRIOV Interface Configuration Guide (OpenStack) `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/patching.rst b/doc/source/operations/patching.rst new file mode 100644 index 000000000..89464c31a --- /dev/null +++ b/doc/source/operations/patching.rst @@ -0,0 +1,15 @@ +================== +StarlingX Patching +================== + +This is a stub page for the topic: StarlingX Patching. You can help StarlingX by +expanding the content. + +See the story for additional information about what is needed: [link] + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/storage_util_display.rst b/doc/source/operations/storage_util_display.rst new file mode 100644 index 000000000..277daa136 --- /dev/null +++ b/doc/source/operations/storage_util_display.rst @@ -0,0 +1,16 @@ +=========================== +Storage Utilization Display +=========================== + +This is a stub page for the topic: Storage Utilization Display. You can help +StarlingX by expanding the content. + +See the story for additional information about what is needed: +`Add Storage Utilization Display Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/doc/source/operations/upgrade.rst b/doc/source/operations/upgrade.rst new file mode 100644 index 000000000..3e1bb35d4 --- /dev/null +++ b/doc/source/operations/upgrade.rst @@ -0,0 +1,16 @@ +================= +Upgrade StarlingX +================= + +This is a stub page for the topic: Upgrade StarlingX. You can help StarlingX by +expanding the content. + +See the story for additional information about what is needed: +`Add Upgrade Guide `_ + +For information about contributing to the StarlingX documentation, see the +:doc:`/contributor/doc_contribute_guide`. + +.. contents:: + :local: + :depth: 1 \ No newline at end of file