diff --git a/doc/source/index.rst b/doc/source/index.rst index 42301aa0fb..69cb8e8d83 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,7 +18,7 @@ Contents: .. sidebar:: HOWTOs * :doc:`third_party` - * :doc:`stackforge` + * :doc:`unofficial_project_hosting` * :doc:`running-your-own` * :doc:`contribute-cloud` @@ -35,7 +35,7 @@ Contents: :hidden: running-your-own - stackforge + unofficial_project_hosting third_party contribute-cloud diff --git a/doc/source/stackforge.rst b/doc/source/stackforge.rst deleted file mode 100644 index 63d04264ef..0000000000 --- a/doc/source/stackforge.rst +++ /dev/null @@ -1,54 +0,0 @@ -:title: StackForge - -.. _stackforge: - -StackForge -########## - -StackForge is the way that OpenStack related projects can consume and -make use of the OpenStack project infrastructure. This includes Gerrit -code review, Jenkins continuous integration, GitHub repository -mirroring, and various small things like IRC bots, pypi uploads, RTFD -updates. Projects should make use of StackForge if they want to run -their project with Gerrit code review and have a trunk gated by Jenkins. - -StackForge projects are expected to be self sufficient when it comes to -configuring Gerrit/Jenkins/Zuul etc. The openstack-infra team can -provide assistance as resources allow, but should not be relied on. - -What StackForge is not: - -* Official endorsement of a project by OpenStack. -* A guarantee of eventual OpenStack incubation (though it is a good - first step in that process as it exposes the project to the - OpenStack way of doing things). - -Note that StackForge and official OpenStack projects were previously -segregated into two separate git namespaces (stackforge/ and -openstack/). They now both occupy the openstack/ namespace though -this does not indicate that all such projects are official OpenStack -projects; it merely indicates that they are developed within the -OpenStack project infrastructure. Projects must apply to the -Technical Committee to become official OpenStack projects. - -Audience -******** - -The focus of StackForge is to provide a place for OpenStack contributors -to maintain related unofficial projects using the same tools and -procedures as they employ when working on official OpenStack projects, -to make it easier for other OpenStack developers to contribute effort to -those projects and in some cases to ease a project's path to incubation -and official integration. As such, the target audience for this document -is current OpenStack developers who are assumed to already be familiar -with how changes are uploaded and reviewed within OpenStack projects. As -an introduction to OpenStack contribution, it is recommend to first read -https://wiki.openstack.org/wiki/How_To_Contribute and then -the `Developer's Guide `_. - -Add a Project to StackForge -*************************** - -For information on adding a project to StackForge, see the `Project -Creator's Guide -`_. diff --git a/doc/source/unofficial_project_hosting.rst b/doc/source/unofficial_project_hosting.rst new file mode 100644 index 0000000000..79f194195c --- /dev/null +++ b/doc/source/unofficial_project_hosting.rst @@ -0,0 +1,65 @@ +:title: Unofficial Projects + +.. _unofficial-projects: + +Unofficial Project Hosting +########################## + +Unoffocial project hosting is the way that OpenStack related projects can +consume and make use of the OpenStack project infrastructure. This +includes Gerrit code review, Zuul continuous integration, GitHub +repository mirroring, and various small things like IRC bots, pypi uploads, +RTFD updates. Projects should make use of being an unofficial project if +they want to run their project with Gerrit code review and have a trunk +gated by Zuul. + +Unofficial projects are expected to be self sufficient when it comes to +configuring Gerrit/Zuul etc. The openstack-infra team can provide +assistance as resources allow, but should not be relied on. + +What being an unoffocial project is not: + +* Official endorsement of a project by OpenStack. +* A guarantee of eventual inclusion as an official OpenStack project + (though it is a good first step in that process as it exposes the project + to the OpenStack way of doing things and tooling). + +Historical Background +********************* + +Previously unofficial projects were hosted as part of "Stackforge" which +had its own namespace in Gerrit and Github (stackforge/). It is common +for unofficial projects to become official projects and when that happened +with the old stackforge/ namespace we had to perform Gerrit downtimes to +rename things to use the openstack/ namespace. In response to this we +collapsed the stackforge/ namespace into the openstack/ namespace. This +means both unofficial projects and official projects are hosted under the +openstack/ namespace in Gerrit and Github. This means that not all +projects under openstack/ are official OpenStack projects they are instead +simply hosted by the OpenStack project infrastructure. + +Eventually the TC decided to completely deprecate the Stackforge name +though you may still hear it being used as short hand for "Unofficial +Project". + +Audience +******** + +The focus of unofficial project hosting is to provide a place for OpenStack +contributors to maintain related unofficial projects using the same tools +and procedures as they employ when working on official OpenStack projects, +to make it easier for other OpenStack developers to contribute effort to +those projects and in some cases to ease a project's path to incubation +and official integration. As such, the target audience for this document +is current OpenStack developers who are assumed to already be familiar +with how changes are uploaded and reviewed within OpenStack projects. As +an introduction to OpenStack contribution, it is recommend to first read +https://wiki.openstack.org/wiki/How_To_Contribute and then +the `Developer's Guide `_. + +Create an Unofficial Project +**************************** + +For information on adding an unofficial project, see the `Project +Creator's Guide +`_.