From ffcdca681b484e85783df96118a77e5b5aad81a5 Mon Sep 17 00:00:00 2001 From: Martin Kopec Date: Sun, 7 Nov 2021 16:57:06 +0000 Subject: [PATCH] Add contributing page and some updates The commit adds contributing page for easier orientation in our projects. Change-Id: I1045f1940d5ead7b1dfdbf5ecaf09b9a38a4606e --- .zuul.yaml | 35 +++++++++++++++++++++++++---------- CONTRIBUTING.rst | 34 ++++++++++++++++++++++++++++++++++ README.rst | 11 +++++++++-- doc/source/contributing.rst | 5 +++++ doc/source/index.rst | 1 + 5 files changed, 74 insertions(+), 12 deletions(-) create mode 100644 CONTRIBUTING.rst create mode 100644 doc/source/contributing.rst diff --git a/.zuul.yaml b/.zuul.yaml index e43f64b..211366f 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -5,19 +5,34 @@ - openstack-python3-yoga-jobs check: jobs: - - refstack-client-devstack-master - - refstack-client-devstack-wallaby - - refstack-client-devstack-victoria - - refstack-client-devstack-ussuri - - refstack-client-devstack-train + - refstack-client-devstack-master: + # Define a list of irrelevant files to use everywhere else + irrelevant-files: &refstack-client-irrelevant-files + - ^.*\.rst$ + - ^doc/.*$ + - ^.gitignore$ + - ^.gitreview$ + - refstack-client-devstack-wallaby: + irrelevant-files: *refstack-client-irrelevant-files + - refstack-client-devstack-victoria: + irrelevant-files: *refstack-client-irrelevant-files + - refstack-client-devstack-ussuri: + irrelevant-files: *refstack-client-irrelevant-files + - refstack-client-devstack-train: + irrelevant-files: *refstack-client-irrelevant-files - opendev-tox-docs gate: jobs: - - refstack-client-devstack-master - - refstack-client-devstack-wallaby - - refstack-client-devstack-victoria - - refstack-client-devstack-ussuri - - refstack-client-devstack-train + - refstack-client-devstack-master: + irrelevant-files: *refstack-client-irrelevant-files + - refstack-client-devstack-wallaby: + irrelevant-files: *refstack-client-irrelevant-files + - refstack-client-devstack-victoria: + irrelevant-files: *refstack-client-irrelevant-files + - refstack-client-devstack-ussuri: + irrelevant-files: *refstack-client-irrelevant-files + - refstack-client-devstack-train: + irrelevant-files: *refstack-client-irrelevant-files - opendev-tox-docs promote: jobs: diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..d811b8b --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,34 @@ +The source repository for this project can be found at: + + https://opendev.org/openinfra/refstack-client + +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: + + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html + +Documentation of the project can be found at: + + https://docs.opendev.org/openinfra/refstack-client/latest/ + +Bugs should be filed on Storyboard: + + https://storyboard.openstack.org/#!/project/openinfra/refstack-client + +Patches against this project can be found at: + + https://review.opendev.org/q/project:openinfra/refstack-client + +To communicate with us you may use one of the following means: + +**Mailing List:** +Get in touch with us via `email `_. +Use [refstack-client] in your subject. + +**IRC:** +We're at #refstack channel on OFTC network. +`Setup IRC `_ + +**Meetings:** +`Visit this link `_ +for the meeting information. diff --git a/README.rst b/README.rst index 92c6a8a..4899c98 100644 --- a/README.rst +++ b/README.rst @@ -209,6 +209,13 @@ integrated to an automation machinery - f.e. we use the role for running every OpenStack Marketing Program of the current guideline. The latest builds can be found here__. -.. _ansible-role-refstack-client: https://opendev.org/x/ansible-role-refstack-client +.. _ansible-role-refstack-client: https://opendev.org/openinfra/ansible-role-refstack-client .. _devstack: https://opendev.org/openstack/devstack/ -.. __builds: https://zuul.openstack.org/builds?project=x%2Fansible-role-refstack-client +.. __builds: https://zuul.openstack.org/builds?project=openinfra%2Fansible-role-refstack-client + +Get Involved +############ + +See the `CONTRIBUTING `_ +guide on how to get involved. + diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 100644 index 0000000..1f5ca23 --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1,5 @@ +============ +Contributing +============ + +.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 73a8074..d6afaab 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,6 +10,7 @@ About refstack-client :maxdepth: 2 readme + contributing ----------------- Approved Features