Merge pull request #2586 from stackhpc/stackhpc-mixin-fixes

Documentation fixes for StackHPC Mixin Environments

Author: Alex-Welsh

doc/source/configuration/stackhpc-mixin-environments.rst

@@ -4,19 +4,18 @@
 StackHPC Mixin Environments
 ===========================
 
-StackHPC Kayobe configuration provides a set of mixin environments, which can
-be used to apply configuration in modular way.  These provide a mechanism where
-users can opt into new sets of configuration mid-cycle, at a time of the their
-choosing, and thereby facilitate gradual adoption of new features.  Config may
-be moved into the the base configuration for the next major release.
+The StackHPC Kayobe configuration uses mixin environments for modular
+configuration. Users can opt into these mid-cycle to gradually adopt new
+features. Mixin environments may be merged into the base configuration in later
+major releases.
 
 For more information about Kayobe environments, please see the `upstream Kayobe
 documentation
 <https://docs.openstack.org/kayobe/latest/multiple-environments.html#defining-kayobe-environments>`__.
 
 .. note::
 
-   To override settings in mixin environments, you will need to define the
+   To override settings in mixin environments, you will need to define
    overrides in an environment that inherits from that one, rather than in the
    base configuration.
 

etc/kayobe/environments/baremetal-policy/README.rst

@@ -18,7 +18,7 @@ Consuming this environment
 Add the ``baremetal-policy`` environment to your  ``.kayobe-environment`` file:
 
 .. code-block:: yaml
-   :caption: $KAYOBE_CONFIG_PATH/$KAYOBE_ENVIRONMENT/.kayobe-environment
+   :caption: $KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/.kayobe-environment
 
    dependencies:
      - baremetal-policy

etc/kayobe/environments/baremetal/README.rst

@@ -9,7 +9,7 @@ Consuming this environment
 Add the ``baremetal`` environment to your  ``.kayobe-environment`` file:
 
 .. code-block:: yaml
-   :caption: $KAYOBE_CONFIG_PATH/$KAYOBE_ENVIRONMENT/.kayobe-environment
+   :caption: $KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/.kayobe-environment
 
    dependencies:
      - baremetal
@@ -38,7 +38,7 @@ this setting if this is a risk you want to take. This can be customised by
 editing the following variables:
 
 .. code-block:: yaml
-    :caption: $KAYOBE_CONFIG_PATH/$KAYOBE_ENVIRONMENT/kolla/config/ironic/ironic-conductor.conf
+    :caption: $KAYOBE_CONFIG_PATH/environments/$KAYOBE_ENVIRONMENT/kolla/config/ironic/ironic-conductor.conf
 
     [deploy]
     erase_devices_priority=10