diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 9080417881..e8a326a73a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -16,4 +16,4 @@ Bugs should be filed on Launchpad: For more specific information about contributing to this repository, see the openstack-ansible contributor guide: - https://docs.openstack.org/openstack-ansible/latest/contributor/contributing.html + https://docs.openstack.org/openstack-ansible/latest/contributors/contributing.html diff --git a/deploy-guide/source/next-steps.rst b/deploy-guide/source/next-steps.rst index 33ebe41557..d5ae2b3218 100644 --- a/deploy-guide/source/next-steps.rst +++ b/deploy-guide/source/next-steps.rst @@ -2,17 +2,18 @@ Next steps ========== -Now that you have verified that your OpenStack cloud -is working, here is what you can do next: +Now that you have verified your OpenStack cloud is operational, here +is what you can do next: Operate OpenStack-Ansible ========================= -Review our :dev_docs:`Operations guide ` -to learn about verifying your environment in more detail, and creating your first networks, images, and instances. +Review our :dev_docs:`Operations Guide ` +to learn about verifying your environment in more detail, and creating +your first networks, images, and instances. Contribute to OpenStack-Ansible =============================== -Review our :dev_docs:`Contributors guide ` -to learn about contributing to OpenStack-Ansible. \ No newline at end of file +Review our :dev_docs:`Developer Documentation ` +to learn about contributing to OpenStack-Ansible. diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index bf5f466e70..170b142c83 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -13,7 +13,7 @@ dependencies on your cloud using OpenStack-Ansible. For user guides, see the :dev_docs:`User Guide `. For information on how to contribute, extend or develop OpenStack-Ansible, -see the :dev_docs:`Contributors Guide `. +see the :dev_docs:`Developer Documentation `. For in-depth technical information, see the :dev_docs:`OpenStack-Ansible Reference `. diff --git a/doc/source/contributors/contributing.rst b/doc/source/contributors/contributing.rst index 7f96552b94..bdb9a297b4 100644 --- a/doc/source/contributors/contributing.rst +++ b/doc/source/contributors/contributing.rst @@ -3,7 +3,7 @@ So You Want to Contribute... ============================ For general information on contributing to OpenStack, please check out the -`contributor guide `_ to get started. +`Contributor Guide `_ to get started. It covers all the basics that are common to all OpenStack projects: the accounts you need, the basics of interacting with our Gerrit review system, how we communicate as a community, etc. @@ -25,11 +25,11 @@ IRC channel The OpenStack-Ansible community communicates in the #openstack-ansible IRC channel hosted on OFTC. This channel is logged, and its logs are published -on http://eavesdrop.openstack.org/irclogs/%23openstack-ansible/. +on https://meetings.opendev.org/irclogs/%23openstack-ansible/ Weekly meetings are held in our IRC channel. The schedule and logs can be found on -http://eavesdrop.openstack.org/#OpenStack_Ansible_Deployment_Meeting. +https://meetings.opendev.org/%23OpenStack_Ansible_Deployment_Meeting The agenda for the next meeting can be found on our `Meetings wiki page `_. @@ -39,7 +39,7 @@ Mailing lists Members of the OpenStack-Ansible community should monitor the **OpenStack-discuss** `mailing lists`_. -.. _mailing lists: http://lists.openstack.org/cgi-bin/mailman/listinfo +.. _mailing lists: https://lists.openstack.org/mailman3/lists/ All our communications should be prefixed with **[openstack-ansible]**. @@ -52,7 +52,6 @@ might be found on `gerrit`_. .. _gerrit: https://review.opendev.org/#/admin/groups/490,members - New Feature Planning ~~~~~~~~~~~~~~~~~~~~ @@ -61,10 +60,9 @@ or infrastructure service, or to improve an existing role, the OpenStack-Ansible project would welcome that contribution and your assistance in maintaining it. -Please look through :dev_docs:`Contributor Guidelines ` +Please look through :dev_docs:`Contributor Guidelines ` page for more information about the process. - Task Tracking ~~~~~~~~~~~~~ @@ -72,11 +70,9 @@ We track our tasks in Launchpad https://bugs.launchpad.net/openstack-ansible - If you're looking for some smaller, easier work item to pick up and get started on, search for the 'low-hanging-fruit' tag. - Reporting a Bug ~~~~~~~~~~~~~~~ @@ -84,10 +80,8 @@ You found an issue and want to make sure we are aware of it? You can do so on `Launchpad `_. - Also you may find more detailed information about how to work with bugs -on the page :dev_docs:`Bug Handling ` - +on the page :dev_docs:`Bug Handling `. Getting Your Patch Merged ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -100,7 +94,6 @@ We follow openstack guidelines for the `code reviewing `_. All Core reviewer duties are described on the page -:dev_docs:`Core Reviewers `. +:dev_docs:`Core Reviewers `. diff --git a/doc/source/contributors/index.rst b/doc/source/contributors/index.rst index d975e6c491..835370284e 100644 --- a/doc/source/contributors/index.rst +++ b/doc/source/contributors/index.rst @@ -18,7 +18,6 @@ see the :dev_docs:`Operations Guide `. For in-depth technical information, see the :dev_docs:`OpenStack-Ansible Reference `. - Contents: .. toctree:: @@ -32,4 +31,3 @@ Contents: periodic-work core-reviewers distributions - diff --git a/doc/source/contributors/project-onboarding.rst b/doc/source/contributors/project-onboarding.rst index 9d95ff3f16..fcac2b7f32 100644 --- a/doc/source/contributors/project-onboarding.rst +++ b/doc/source/contributors/project-onboarding.rst @@ -19,31 +19,25 @@ each of them with specific use cases, and different sets of practices. - Repository purpose * - | **OpenStack-Ansible** | Also called *integrated repository* - - * https://github.com/openstack/openstack-ansible + - * https://opendev.org/openstack/openstack-ansible - Our main repository, used by deployers. Uses the other repositories. * - | The **OpenStack-Ansible roles** repositories - - * https://github.com/openstack/openstack-ansible-os_nova - * https://github.com/openstack/openstack-ansible-os_glance - * https://github.com/openstack/ansible-role-systemd_mount - * https://github.com/openstack/ansible-config_template - * https://github.com/openstack/ansible-hardening + - * https://opendev.org/openstack/openstack-ansible-os_nova + * https://opendev.org/openstack/openstack-ansible-os_glance + * https://opendev.org/openstack/ansible-role-systemd_mount + * https://opendev.org/openstack/ansible-config_template + * https://opendev.org/openstack/ansible-hardening * ... - Each role is in charge of deploying **exactly one** component of an OpenStack-Ansible deployment. - * - | The **tests repository** - - * https://github.com/openstack/openstack-ansible-tests - - | The tests repository is the location for common code used in - the integrated repo and role repos tests. - | It allows us to not repeat ourselves: it is the location of - common playbooks, common tasks and scripts. * - | The **specs** repository - - * https://github.com/openstack/openstack-ansible-specs + - * https://opendev.org/openstack/openstack-ansible-specs - This repository contains all the information concerning large bodies of work done in OpenStack-Ansible, split by cycle. * - | The **ops** repository - - * https://github.com/openstack/openstack-ansible-ops + - * https://opendev.org/openstack/openstack-ansible-ops - This repository is an incubator for new projects, each project solving a particular operational problem. Each project has its own folder in this repository. @@ -95,7 +89,6 @@ Community communication channels IRC channel ^^^^^^^^^^^ - .. warning:: The OpenStack Community moved the IRC network from Freenode to OFTC on May 31, @@ -105,11 +98,12 @@ IRC channel The OpenStack-Ansible community communicates a lot through IRC, in the #openstack-ansible channel, on OFTC. This channel is logged, and its logs are published on -http://eavesdrop.openstack.org/irclogs/%23openstack-ansible/. +https://meetings.opendev.org/irclogs/%23openstack-ansible/ Weekly meetings are held in our IRC channel. The schedule and logs can be found on -http://eavesdrop.openstack.org/#OpenStack_Ansible_Deployment_Meeting. +https://meetings.opendev.org/%23OpenStack_Ansible_Deployment_Meeting + Next meeting agenda can be found on our `Meetings wiki page `_. @@ -119,7 +113,6 @@ Mailing lists A member of the OpenStack-Ansible community should monitor the **OpenStack-discuss** `mailing lists`_. -.. _mailing lists: http://lists.openstack.org/cgi-bin/mailman/listinfo +.. _mailing lists: https://lists.openstack.org/mailman3/lists/ All our communications should be prefixed with **[openstack-ansible]**. - diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index cfd00df096..4526933809 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -14,7 +14,7 @@ For information on how to manage and operate OpenStack-Ansible, see the see the :dev_docs:`Operations Guide `. For information on how to contribute, extend or develop OpenStack-Ansible, -see the :dev_docs:`Contributors Guide `. +see the :dev_docs:`Developer Documentation `. For in-depth technical information, see the :dev_docs:`OpenStack-Ansible Reference `.