diff --git a/doc/source/code-and-documentation/index.rst b/doc/source/code-and-documentation/index.rst index 2c2cbad..ece1700 100644 --- a/doc/source/code-and-documentation/index.rst +++ b/doc/source/code-and-documentation/index.rst @@ -6,7 +6,7 @@ Code & Documentation Contributor Guide :caption: Code and Documentation Contributors :maxdepth: 2 - /common/introduction + /code-and-documentation/introduction /common/irc /common/communication /common/accounts diff --git a/doc/source/code-and-documentation/introduction.rst b/doc/source/code-and-documentation/introduction.rst new file mode 100644 index 0000000..934d330 --- /dev/null +++ b/doc/source/code-and-documentation/introduction.rst @@ -0,0 +1,17 @@ +############ +Introduction +############ + +The heart of open source is the people who are participating in a community and +it is no different in case of OpenStack either. + +This chapter will guide you through of all the tools and processes that we are +using to develop, test, maintain, and document the projects in OpenStack. + +Communication is underrated, but crucial when it comes to participating in an +open source community. We have several tools that we use for online and offline +communication, which we encourage you to use. + +We do not differentiate between the different types of contributions such as +code or documentation therefore you will find guidance in this chapter for all +types. diff --git a/doc/source/index.rst b/doc/source/index.rst index dfff205..7b1e30d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,6 +10,7 @@ The OpenStack Contributor Guide .. toctree:: :maxdepth: 1 + common/introduction code-and-documentation/index users/index operators/index diff --git a/doc/source/operators/index.rst b/doc/source/operators/index.rst index e26bcef..fe9ed34 100644 --- a/doc/source/operators/index.rst +++ b/doc/source/operators/index.rst @@ -6,6 +6,7 @@ Operators' Contributor Guide :caption: Operator Contributors :maxdepth: 2 + /operators/introduction /common/introduction /common/irc /common/accounts diff --git a/doc/source/operators/introduction.rst b/doc/source/operators/introduction.rst new file mode 100644 index 0000000..4788add --- /dev/null +++ b/doc/source/operators/introduction.rst @@ -0,0 +1,13 @@ +############ +Introduction +############ + +OpenStack is running in production all around the globe resulting in a large +group of people who's daily job is to deploy and operate the platform. + +We actively encourage operators to participate and engage with the community to +provide feedback and help us shape the software and documentation to be more +user friendly. + +To find documentation on how to deploy and run OpenStack you can look up the +`OpenStack Manuals `_ web page. diff --git a/doc/source/users/index.rst b/doc/source/users/index.rst index 3ab1ac1..6e2106c 100644 --- a/doc/source/users/index.rst +++ b/doc/source/users/index.rst @@ -6,6 +6,7 @@ Users' Contributor Guide :caption: User Contributors :maxdepth: 2 + /users/introduction /common/irc /common/accounts /common/communication diff --git a/doc/source/users/introduction.rst b/doc/source/users/introduction.rst new file mode 100644 index 0000000..96b28b1 --- /dev/null +++ b/doc/source/users/introduction.rst @@ -0,0 +1,13 @@ +############ +Introduction +############ + + +OpenStack is running in production all around the globe addressing use cases +from all parts of the industry. + +We actively encourage operators to participate and engage with the community to +share feedback and views on emerging use cases and requirements to address. + +To find documentation on how to deploy and run OpenStack you can look up the +`OpenStack Manuals `_ web page.