opendev/gerrit
Code Issues Proposed changes

Move docs about project state to "config-project-config.txt"

Browse Source 
We have two documents, e.g. "config-project-config.txt" and
"project-configuration.txt", containing doc for project
configs. "config-project-config.txt" intends to document
avaliable configs to the project through "project.config",
"rules.pl" and "groups" file. "project.configuration" intends
to document the configs avaliable through the UI. However,
both of them are not complete, making it hard for users to
learn how to config their projects.

This commit and followup commits proposes to move docs
about "Project Options" in "project-configuration.txt" to
"config-project-config.txt" and then just referencing them
from "project-configuration.txt". Hopefully, this could
make it easier for users to understand Gerrit project configs.

Change-Id: I0cf5013bd5260cf69cdb6e8ec51608cfc1d59d79
This commit is contained in:
Changcheng Xiao
2019-01-15 17:17:04 +01:00
parent 7b78caf742
commit 5ecb6422b6
2 changed files with 36 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
Documentation/config-project-config.txt
View File

@@ -96,7 +96,41 @@ The project section includes configuration of project settings.
These are the keys: These are the keys:
- Description [[description]]description::
+
A description for the project.
[[state]]state:
+
This setting defines the state of the project. A project can have the
following states:
- `Active`:
+
The project is active and users can see and modify the project according
to their access rights on the project.
- `Read Only`:
+
The project is read only and all modifying operations on it are
disabled. E.g. this means that pushing to this project fails for all
users even if they have push permissions assigned on it.
+
Setting a project to this state is an easy way to temporary close a
project, as you can keep all write access rights in place and they will
become active again as soon as the project state is set back to
`Active`.
+
This state also makes sense if a project was moved to another location.
In this case all new development should happen in the new project and
you want to prevent that somebody accidentally works on the old
project, while keeping the old project around for old references.
- `Hidden`:
+
The project is hidden and only visible to project owners. Other users
are not able to see the project even if they have read permissions
granted on the project.
[[receive-section]] [[receive-section]]

29
Documentation/project-configuration.txt
View File

@@ -143,35 +143,8 @@ to do a content merge when a path conflict occurs.
[[project-state]] [[project-state]]
=== State === State
This setting defines the state of the project. A project can have the See details at link:config-project-config.html#project-section[project section].
following states:
- `Active`:
+
The project is active and users can see and modify the project according
to their access rights on the project.
- `Read Only`:
+
The project is read only and all modifying operations on it are
disabled. E.g. this means that pushing to this project fails for all
users even if they have push permissions assigned on it.
+
Setting a project to this state is an easy way to temporary close a
project, as you can keep all write access rights in place and they will
become active again as soon as the project state is set back to
`Active`.
+
This state also makes sense if a project was moved to another location.
In this case all new development should happen in the new project and
you want to prevent that somebody accidentally works on the old
project, while keeping the old project around for old references.
- `Hidden`:
+
The project is hidden and only visible to project owners. Other users
are not able to see the project even if they have read permissions
granted on the project.
=== Use target branch when determining new changes to open === Use target branch when determining new changes to open