From 7321205c0678b42d41d774a1ff14bec9a4a9c8e1 Mon Sep 17 00:00:00 2001 From: Mark Goddard Date: Sun, 4 Aug 2019 18:53:23 +0100 Subject: [PATCH] Update docs after repo rename x/ to openstack/ Depends-On: https://review.opendev.org/669298 Change-Id: Ia4138179132d3a284b0c4bcc882b87bde22c9cc4 --- README.rst | 4 ++-- doc/source/conf.py | 2 +- doc/source/configuration/kayobe.rst | 2 +- doc/source/development/automated.rst | 14 +++++++------- doc/source/development/testing.rst | 2 +- doc/source/development/vagrant.rst | 2 +- doc/source/index.rst | 5 +++-- doc/source/installation.rst | 2 +- doc/source/upgrading.rst | 2 +- 9 files changed, 18 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index ab86886b8..f714a6338 100644 --- a/README.rst +++ b/README.rst @@ -27,8 +27,8 @@ All this and more, automated from top to bottom using Ansible. * Free software: Apache license * Documentation: https://docs.openstack.org/kayobe/latest/ -* Source: https://opendev.org/x/kayobe -* Bugs: https://storyboard.openstack.org/#!/project/x/kayobe +* Source: https://opendev.org/openstack/kayobe +* Bugs: https://storyboard.openstack.org/#!/project/openstack/kayobe * Release Notes: https://docs.openstack.org/releasenotes/kayobe/ * IRC: #openstack-kolla diff --git a/doc/source/conf.py b/doc/source/conf.py index d84d95700..682126a74 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -104,7 +104,7 @@ latex_documents = [ # openstackdocstheme options # TODO(mgoddard): Change to openstack/kayobe. -repository_name = 'x/kayobe' +repository_name = 'openstack/kayobe' bug_project = 'kayobe' bug_tag = '' openstack_projects = [ diff --git a/doc/source/configuration/kayobe.rst b/doc/source/configuration/kayobe.rst index 19276d6d3..2b0dab34b 100644 --- a/doc/source/configuration/kayobe.rst +++ b/doc/source/configuration/kayobe.rst @@ -62,7 +62,7 @@ variables. Configuring Kayobe ================== -The `kayobe-config `_ git +The `kayobe-config `_ git repository contains a Kayobe configuration directory structure and unmodified configuration files. This repository can be used as a mechanism for version controlling Kayobe configuration. As Kayobe is updated, the configuration diff --git a/doc/source/development/automated.rst b/doc/source/development/automated.rst index 240d8c4b0..f428b7ee5 100644 --- a/doc/source/development/automated.rst +++ b/doc/source/development/automated.rst @@ -16,7 +16,7 @@ The kayobe development environment automation tooling is built using simple shell scripts. Some minimal configuration can be applied by setting the environment variables in `dev/config.sh`. Control plane configuration is typically provided via the `kayobe-config-dev -`_ repository, +`_ repository, although it is also possible to use your own kayobe configuration. This allows us to build a development environment that is as close to production as possible. @@ -42,7 +42,7 @@ Preparation Clone the kayobe repository:: - git clone https://opendev.org/x/kayobe.git + git clone https://opendev.org/openstack/kayobe.git Change the current directory to the kayobe repository:: @@ -51,7 +51,7 @@ Change the current directory to the kayobe repository:: Clone the ``kayobe-config-dev`` repository to ``config/src/kayobe-config``:: mkdir -p config/src - git clone https://opendev.org/x/kayobe-config-dev.git config/src/kayobe-config + git clone https://opendev.org/openstack/kayobe-config-dev.git config/src/kayobe-config Inspect the kayobe configuration and make any changes necessary for your environment. @@ -177,7 +177,7 @@ Preparation Clone the kayobe repository:: - git clone https://opendev.org/x/kayobe.git + git clone https://opendev.org/openstack/kayobe.git Change to the ``kayobe`` directory:: @@ -186,7 +186,7 @@ Change to the ``kayobe`` directory:: Clone the ``kayobe-config-dev`` repository to ``config/src/kayobe-config``:: mkdir -p config/src - git clone https://opendev.org/x/kayobe-config-dev.git config/src/kayobe-config + git clone https://opendev.org/openstack/kayobe-config-dev.git config/src/kayobe-config Inspect the kayobe configuration and make any changes necessary for your environment. @@ -266,7 +266,7 @@ The following commands should be executed on the seed hypervisor. Clone the kayobe repository:: - git clone https://opendev.org/x/kayobe.git + git clone https://opendev.org/openstack/kayobe.git Change the current directory to the kayobe repository:: @@ -318,7 +318,7 @@ The following commands should be executed on the seed hypervisor. Clone the kayobe repository:: - git clone https://opendev.org/x/kayobe.git + git clone https://opendev.org/openstack/kayobe.git Change to the ``kayobe`` directory:: diff --git a/doc/source/development/testing.rst b/doc/source/development/testing.rst index 961d417c1..9cdb7b8f7 100644 --- a/doc/source/development/testing.rst +++ b/doc/source/development/testing.rst @@ -52,7 +52,7 @@ git:: # from your home or source directory cd ~ - git clone https://opendev.org/x/kayobe.git + git clone https://opendev.org/openstack/kayobe.git cd kayobe Running Unit and Style Tests diff --git a/doc/source/development/vagrant.rst b/doc/source/development/vagrant.rst index c7970ca3a..5955f69df 100644 --- a/doc/source/development/vagrant.rst +++ b/doc/source/development/vagrant.rst @@ -39,7 +39,7 @@ accessing the VM. Clone the kayobe repository:: - git clone https://opendev.org/x/kayobe.git + git clone https://opendev.org/openstack/kayobe.git Change the current directory to the kayobe repository:: diff --git a/doc/source/index.rst b/doc/source/index.rst index 1a7e62d5f..3115a2da9 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,8 +14,9 @@ Welcome to the Kayobe documentation, the official source of information for understanding and using Kayobe. This documentation is maintained at opendev.org -`here `_. Feedback and contributions welcome, -see :doc:`contributing ` for information on how. +`here `_. Feedback and contributions +welcome, see :doc:`contributing ` for information on +how. .. include:: ../../README.rst diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 5bdf72663..a2ae11bd9 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -120,7 +120,7 @@ code repositories and python virtual environments:: Next, obtain the Kayobe source code. For example:: $ cd /src - $ git clone https://opendev.org/x/kayobe.git + $ git clone https://opendev.org/openstack/kayobe.git Create a virtualenv for Kayobe:: diff --git a/doc/source/upgrading.rst b/doc/source/upgrading.rst index 8b1b43e7c..cf0be2707 100644 --- a/doc/source/upgrading.rst +++ b/doc/source/upgrading.rst @@ -79,7 +79,7 @@ Migrating Kayobe Configuration Kayobe configuration options may be changed between releases of kayobe. Ensure that all site local configuration is migrated to the target version format. If -using the `kayobe-config `_ git +using the `kayobe-config `_ git repository to manage local configuration, this process can be managed via git. For example, to fetch version 1.0.0 of the configuration from the ``origin`` remote and merge it into the current branch::