From 0f0badbdcc29b312cbf8f092c9e7a3990ee319f6 Mon Sep 17 00:00:00 2001 From: John Garbutt Date: Thu, 9 Jul 2015 13:30:52 +0100 Subject: [PATCH] docs: add a placeholder link to mentoring docs Adding docs to make it clear how to get more involved. As a first step, lets link to the docs we are working on in the wiki. At a later date we can graduate the wiki docs into here. blueprint devref-refresh-liberty Change-Id: If6c24bc4522eab72354c1602ceaa07352104a34d --- doc/source/how_to_get_involved.rst | 42 ++++++++++++++++++++++++++++++ doc/source/index.rst | 2 ++ doc/source/process.rst | 38 +++++++++++++++++++++++++++ 3 files changed, 82 insertions(+) create mode 100644 doc/source/how_to_get_involved.rst create mode 100644 doc/source/process.rst diff --git a/doc/source/how_to_get_involved.rst b/doc/source/how_to_get_involved.rst new file mode 100644 index 0000000000..957f5bcc93 --- /dev/null +++ b/doc/source/how_to_get_involved.rst @@ -0,0 +1,42 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +===================================== +How to get (more) involved with Nova +===================================== + +So you want to get more involved with Nova. Welcome! + + +New to OpenStack? +================== + +If you are new to OpenStack, please read the general guides on how you can +get more involved with OpenStack: + +* http://www.openstack.org/assets/welcome-guide/OpenStackWelcomeGuide.pdf +* https://wiki.openstack.org/wiki/How_To_Contribute +* http://www.openstack.org/community/ + +New to Nova? +============ + +So you are new to Nova. We are currently working on some docs so its easy +to get more involved. Please see the drafts that are available here: + +* Mentoring efforts, and getting started tips: + https://wiki.openstack.org/wiki/Nova/Mentoring +* Info on process, with a focus on how you can go from an idea + to getting code merged Nova: + https://wiki.openstack.org/wiki/Nova/Liberty_Release_Schedule + diff --git a/doc/source/index.rst b/doc/source/index.rst index 4a0e6fe4dc..f17bc6b9bf 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -93,6 +93,7 @@ actually does, and why. .. toctree:: :maxdepth: 1 + how_to_get_involved architecture project_scope development.environment @@ -117,6 +118,7 @@ community, while keeping users happy and keeping developers productive. .. toctree:: :maxdepth: 1 + process blueprints policies diff --git a/doc/source/process.rst b/doc/source/process.rst new file mode 100644 index 0000000000..eb07f58370 --- /dev/null +++ b/doc/source/process.rst @@ -0,0 +1,38 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +===================== +Developement Process +===================== + +Nova is always evolving its processes, but its import to explain why we have +this process, so we all work to ensure the interactions we need to happen do +happen. The process we have should always be there to make it easier for good +communication between all members of our community. + +OpenStack Wide Patterns +======================== + +Nova follows most of the generally adopted norms for OpenStack projects. +You can get more details here: + +* http://docs.openstack.org/infra/manual/developers.html +* http://git.openstack.org/cgit/openstack/project-team-guide + +Nova Process +============= + +This documentation is still a work in progress. +There is some draft information available on the wiki: + +* https://wiki.openstack.org/wiki/Nova/Liberty_Release_Schedule