Merge "Create archive for old config guides"

doc/source/archive/configuration/brand_config.rst

@@ -2,6 +2,12 @@
 Branding Configuration
 ======================
 
+.. note::
+
+   This guide was replaced by:
+   :ref:`Brand the Login Banner During Commissioning <branding-the-login-banner-during-commissioning>`
+
+
 This is a stub page for the topic: Branding Configuration. You can help
 StarlingX by expanding the content.
 

doc/source/archive/configuration/cert_config.rst

@@ -2,6 +2,11 @@
 Certificate Configuration
 =========================
 
+.. note::
+
+   This guide was replaced by:
+   :ref:`HTTPS and Certificates Management Overview <https-access-overview>`
+
 This guide describes how to enable secure HTTPS access and manage certificates
 using StarlingX.
 

doc/source/archive/configuration/host_config.rst

@@ -2,6 +2,11 @@
 Host Configuration
 ==================
 
+.. note::
+
+   This guide was replaced by:
+   :doc:`Node Management Guide </node_management/index>`
+
 This is a stub page for the topic: Host Configuration. You can help StarlingX by
 expanding the content.
 

doc/source/archive/configuration/host_interface_network_config.rst

@@ -2,6 +2,10 @@
 Host Interface and Network Configuration
 ========================================
 
+.. note::
+
+   This guide was replaced by: :doc:`Node Management Guide </node_management/index>`
+
 This guide describes the following:
 
 .. contents::

doc/source/archive/configuration/index.rst

@@ -0,0 +1,52 @@
+=============
+Configuration
+=============
+
+.. note::
+
+   These guides are deprecated and no longer maintained. Links to replacement
+   guides (if applicable) are included within each guide.
+
+
+---------------------
+General Configuration
+---------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   brand_config
+   cert_config
+   host_config
+   host_interface_network_config
+   intel_n3000_fpga
+   system_config
+   time_sync_config
+
+
+
+------------------------
+Kubernetes Configuration
+------------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   k8s_auth_winactivedir
+   k8s_persistent_vol
+   k8s_pod_sec_policies
+   k8s_res_policies
+   k8s_upgrade
+
+-----------------------
+OpenStack Configuration
+-----------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   openstack_cinder_config
+   openstack_ironic_config
+   openstack_swift_config
+
+

doc/source/archive/configuration/intel_n3000_fpga.rst

@@ -2,6 +2,10 @@
 Host FPGA Configuration - Intel N3000
 =====================================
 
+.. note::
+
+   This guide was replaced by: :ref:`N3000 FPGA Overview <n3000-overview>`
+
 This guide describes how to configure and integrate an Intel N3000 |FPGA|
 |PAC| on StarlingX.
 

doc/source/archive/configuration/k8s_auth_winactivedir.rst

@@ -2,6 +2,11 @@
 Authenticate Kubernetes Users with Windows Active Directory Server
 ==================================================================
 
+.. note::
+
+   This guide was replaced by:
+   :ref:`Overview of Windows Active Directory <overview-of-windows-active-directory>`
+
 This guide describes how to authenticate users of the Kubernetes API via a
 remote Windows Active Directory server, using the oidc-auth-apps application.
 

doc/source/archive/configuration/k8s_persistent_vol.rst

@@ -2,6 +2,11 @@
 Persistent Volume Configuration
 ===============================
 
+.. note::
+
+   This guide was replaced by:
+   :ref:`About Persistent Volume Support <about-persistent-volume-support>`
+
 This is a stub page for the topic: Configuring Persistent Volume Support. You
 can help StarlingX by expanding the content.
 

doc/source/archive/configuration/k8s_pod_sec_policies.rst

@@ -2,6 +2,10 @@
 Pod Security Policies
 =====================
 
+.. note::
+
+   This guide was replaced by: :ref:`Pod Security Policies <pod-security-policies>`
+
 This guide describes how to enable Kubernetes pod security policies.
 
 .. contents::

doc/source/archive/configuration/k8s_res_policies.rst

@@ -2,6 +2,10 @@
 Resource Policies
 =================
 
+.. note::
+
+   This guide was replaced by: :ref:`Resource Management <resource-management>`
+
 This guide describes two Kubernetes resource policies, LimitRange and
 ResourceQuota, which are enabled by default on StarlingX.
 

doc/source/archive/configuration/k8s_upgrade.rst

@@ -2,6 +2,10 @@
 Upgrade Kubernetes version
 ==========================
 
+.. note::
+
+   This guide was replaced by: :ref:`Manual Kubernetes Version Upgrade <manual-kubernetes-components-upgrade>`
+
 This section describes how to upgrade the components on a system running
 StarlingX from one supported version of Kubernetes (K8s) to another supported
 version.

doc/source/archive/configuration/openstack_cinder_config.rst

@@ -2,6 +2,11 @@
 OpenStack Cinder File System Configuration
 ==========================================
 
+.. note::
+
+   This guide was replaced by:
+   :ref:`Configure the Optional Image Conversion File System <configure-an-optional-cinder-file-system>`
+
 This guide describes an optional file system that can be used by Cinder to
 convert qcow2 images to raw format.
 

doc/source/archive/configuration/openstack_ironic_config.rst

@@ -2,6 +2,12 @@
 OpenStack Ironic Configuration
 ==============================
 
+.. note::
+
+   This guide was replaced by:
+   :ref:`Configure OpenStack Services Using Helm Chart Overrides <sysconf_openstack_index>`
+
+
 This is a stub page for the topic: OpenStack Ironic Configuration and Management.
 You can help StarlingX by expanding the content.
 

doc/source/archive/configuration/openstack_swift_config.rst

@@ -2,6 +2,11 @@
 OpenStack Swift Configuration
 =============================
 
+.. note::
+
+   This guide was replaced by:
+   :ref:`Configure OpenStack Services Using Helm Chart Overrides <sysconf_openstack_index>`
+
 This is a stub page for the topic: OpenStack Swift Configuration. You can help
 StarlingX by expanding the content.
 

doc/source/archive/configuration/system_config.rst

@@ -2,6 +2,12 @@
 System Configuration
 =====================
 
+.. note::
+
+   This guide was replaced by:
+   :ref:`System Configuration Guide <sysconf_main_index>`
+
+
 This is a stub page for the topic: System Configuration. You can help StarlingX
 by expanding the content.
 

doc/source/archive/configuration/time_sync_config.rst

@@ -2,6 +2,11 @@
 Time Synchronization Configuration
 ==================================
 
+.. note::
+
+   This guide was replaced by:
+   :ref:`Configure NTP Servers Using Horizon <configuring-ntp-servers-and-services-using-horizon>`
+
 This is a stub page for the topic: Time Synchronization Configuration. You can
 help StarlingX by expanding the content.
 

doc/source/archive/index-documentation-archive-900988dce206.rst

@@ -0,0 +1,21 @@
+.. _index-documentation-archive-900988dce206:
+
+=====================
+Documentation Archive
+=====================
+
+.. note::
+
+   These guides are deprecated and no longer maintained. Links to replacement
+   guides (if applicable) are included within each guide.
+
+
+*************
+Configuration
+*************
+
+.. toctree::
+   :maxdepth: 2
+
+   configuration/index
+

doc/source/cli_ref/system.rst

@@ -919,7 +919,7 @@ Kubernetes version upgrade
 
 The following set of commands allow you to upgrade the version of Kubernetes.
 For more information, see
-:doc:`Kubernetes upgrade </configuration/k8s_upgrade>`.
+:ref:`Manual Kubernetes Version Upgrade <manual-kubernetes-components-upgrade>`.
 
 ``kube-host-upgrade``
     Perform Kubernetes upgrade for a host.

doc/source/configuration/index.rst

@@ -2,44 +2,15 @@
 Configuration
 =============
 
----------------------
+.. note::
-General Configuration
+
----------------------
+   The guides in this folder were moved to
+   :ref:`Documentation archive <index-documentation-archive-900988dce206>`.
+
 
 .. toctree::
    :maxdepth: 1
+   :hidden:
 
-   brand_config
-   cert_config
-   host_config
-   host_interface_network_config
-   intel_n3000_fpga
    docker_proxy_config
-   system_config
-   time_sync_config
-
-------------------------
-Kubernetes Configuration
-------------------------
-
-.. toctree::
-   :maxdepth: 1
-
-   k8s_auth_winactivedir
-   k8s_persistent_vol
-   k8s_pod_sec_policies
-   k8s_res_policies
-   k8s_upgrade
-
------------------------
-OpenStack Configuration
------------------------
-
-.. toctree::
-   :maxdepth: 1
-
-   openstack_cinder_config
-   openstack_ironic_config
-   openstack_swift_config
-
 

doc/source/contributor/doc_contribute_guide.rst

@@ -84,7 +84,7 @@ Documentation for StarlingX is organized into the following sections:
 :doc:`/deploy_install_guides/index`
   Release-specific installation and deployment guides.
 
-:doc:`/configuration/index`
+:doc:`/archive/configuration/index`
   Configuration references for post-installation StarlingX system configuration.
 
 :doc:`/operations/index`

doc/source/index.rst

@@ -200,20 +200,20 @@ Deprecated guides
 The guides listed here have been replaced by new guides that provide more
 details.
 
-*************
-Configuration
-*************
 
 .. toctree::
    :maxdepth: 2
 
+   archive/index-documentation-archive-900988dce206
+
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
    configuration/index
 
 
-****************
-Operation guides
-****************
-
 .. toctree::
    :maxdepth: 2
 

doc/source/releasenotes/r4_release.rst

@@ -44,7 +44,7 @@ associated user guides (if applicable).
   card's firmware.
 
   Guide: :doc:`Host FPGA Configuration for the Intel N3000 FPGA Programmable
-  Acceleration Card </configuration/intel_n3000_fpga>`
+  Acceleration Card </archive/configuration/intel_n3000_fpga>`
 
 * Kata Containers
 
@@ -61,7 +61,7 @@ associated user guides (if applicable).
   Kubernetes API.
 
   Guide: :doc:`Authenticate Kubernetes Users with Windows Active Directory
-  Server </configuration/k8s_auth_winactivedir>`
+  Server </archive/configuration/k8s_auth_winactivedir>`
 
 * Certificate Manager Integration
 
@@ -69,7 +69,7 @@ associated user guides (if applicable).
   certificate issuance, monitor certificate expiration dates, and configure
   an auto-renew process.
 
-  Guide: :doc:`Enable secure HTTPS access and manage certificates </configuration/cert_config>`
+  Guide: :doc:`Enable secure HTTPS access and manage certificates </archive/configuration/cert_config>`
 
 * Time-Sensitive Networking (TSN) in Kata Containers
 
@@ -103,7 +103,7 @@ associated user guides (if applicable).
   StarlingX now has the capability of updating the Kubernetes images
   installed on the platform.
 
-  Guide: :doc:`Upgrade your Kubernetes version </configuration/k8s_upgrade>`
+  Guide: :doc:`Upgrade your Kubernetes version </archive/configuration/k8s_upgrade>`
 
 * Redfish virtual media support