opendev/gerrit
Code Issues Proposed changes
Files
5ecb6422b6ca2b08ea51a32098c151fd07307f70
gerrit/Documentation
History
Changcheng Xiao 5ecb6422b6 Move docs about project state to "config-project-config.txt" 
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
2019-01-15 18:22:49 +01:00
..
images
Rewrite Inline Edit to describe new UI.
2018-08-28 14:39:15 -07:00
.gitignore
…
access-control.txt
Document that the 'View Private Changes' capability allows to view all change edit refs
2018-12-28 14:09:56 +00:00
BUILD
Merge branch 'stable-2.16'
2018-12-11 17:52:52 +09:00
cmd-apropos.txt
Documentation: Also consider the use of kerberos authentication over SSH
2017-08-28 01:44:52 +02:00
cmd-ban-commit.txt
Fix formatting of example blocks
2016-07-07 14:06:31 +02:00
cmd-cherry-pick.txt
Fix formatting of example blocks
2016-07-07 14:06:31 +02:00
cmd-close-connection.txt
Add a period to the end of description sentence
2018-09-24 09:33:48 -07:00
cmd-create-account.txt
Remove spaces in front of example
2018-09-24 09:38:45 -07:00
cmd-create-branch.txt
Clean up syntax of cmd-create-branch.txt
2018-09-24 18:36:21 +00:00
cmd-create-group.txt
Clean up syntax of cmd-create-group.txt
2018-09-24 23:07:27 +00:00
cmd-create-project.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
cmd-flush-caches.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
cmd-gc.txt
Clean up syntax of cmd-gc.txt
2018-09-24 23:07:53 +00:00
cmd-hook-commit-msg.txt
Clean up syntax of cmd-hook-commit-msg.txt
2018-09-24 23:08:14 +00:00
cmd-index-activate.txt
Clean up syntax of cmd-index-activate.txt
2018-09-24 21:28:19 -07:00
cmd-index-changes-in-project.txt
Clean up syntax of cmd-index-changes-in-project.txt
2018-09-24 21:30:48 -07:00
cmd-index-changes.txt
Clean up syntax for cmd-index-changes.txt
2018-09-24 21:33:42 -07:00
cmd-index-start.txt
Clear up syntax for command reference files
2018-09-26 12:31:46 -07:00
cmd-index.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
cmd-kill.txt
Clear up syntax for command reference files
2018-09-26 12:31:46 -07:00
cmd-logging-ls-level.txt
Clear up syntax for command reference files
2018-09-26 12:31:46 -07:00
cmd-logging-set-level.txt
Clear up syntax for command reference files
2018-09-26 12:31:46 -07:00
cmd-ls-groups.txt
Clear up syntax for command reference files
2018-09-26 12:31:46 -07:00
cmd-ls-members.txt
Clear up syntax for command reference files
2018-09-26 12:31:46 -07:00
cmd-ls-projects.txt
Clear up syntax for command reference files
2018-09-26 12:31:46 -07:00
cmd-ls-user-refs.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
cmd-plugin-enable.txt
Clear up syntax for command reference files
2018-09-26 12:31:46 -07:00
cmd-plugin-install.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-plugin-ls.txt
Fix broken synopsis formatting in documentation
2016-07-06 10:54:42 +02:00
cmd-plugin-reload.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-plugin-remove.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-query.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
cmd-receive-pack.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-reload-config.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-rename-group.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-review.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
cmd-set-account.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-set-head.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-set-members.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-set-project-parent.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-set-project.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-set-reviewers.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-show-caches.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-show-connections.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-show-queue.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-stream-events.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-suexec.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-test-submit-rule.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-test-submit-type.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
cmd-version.txt
Clean up remaining command reference files
2018-11-12 19:22:29 +00:00
concept-changes.txt
Merge branch 'stable-2.15'
2018-09-27 16:45:10 +09:00
concept-patch-sets.txt
Add new concept topic, Patch Sets, to documentation
2017-08-09 19:07:02 -07:00
concept-refs-for-namespace.txt
Add new concept topic on refs/for namespace
2017-08-09 19:02:17 -07:00
config-accounts.txt
Add warning about changing external IDs manually
2018-09-20 09:48:03 +02:00
config-auto-site-initialization.txt
Update auto-site initialization documentation
2019-01-11 14:44:23 -08:00
config-cla.txt
Add project scope feature to contributor-agreement enforcement.
2018-10-17 17:41:53 +00:00
config-gerrit.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
config-gitweb.txt
Document that gitweb.type must be set
2018-03-16 09:47:32 +09:00
config-groups.txt
Documentation: describe NoteDb group storage
2017-12-05 15:57:58 +01:00
config-hooks.txt
Update plugin links in documentation
2018-09-28 16:07:43 +09:00
config-labels.txt
Add config and rule to ignore self approval on labels
2018-09-07 15:14:37 +02:00
config-login-register.txt
Use "gerrit" as the Gerrit user instead of "gerrit2"
2017-07-04 21:20:47 +09:00
config-mail.txt
Merge branch 'stable-2.15'
2018-05-02 11:21:18 +09:00
config-plugins.txt
Add saml plugin
2019-01-06 10:40:08 +00:00
config-project-config.txt
Move docs about project state to "config-project-config.txt"
2019-01-15 18:22:49 +01:00
config-reverseproxy.txt
…
config-robot-comments.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
config-sso.txt
Merge branch 'stable-2.14' into stable-2.15
2018-02-02 13:39:59 +09:00
config-themes.txt
Remove GWT UI
2018-11-13 15:06:26 -08:00
config-validation.txt
Add validation listener for account activation
2018-04-25 09:50:07 +02:00
dev-bazel.txt
Remove GWT UI
2018-11-13 15:06:26 -08:00
dev-build-plugins.txt
Expand docs on how to include external dependencies in core plugins
2018-02-27 17:06:26 +09:00
dev-contributing.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
dev-design.txt
dev-design: Remove section about JSON-RPC
2018-12-21 00:43:19 +09:00
dev-eclipse.txt
Remove GWT UI
2018-11-13 15:06:26 -08:00
dev-inspector.txt
dev-inspector.txt: Remove references to ReviewDb
2018-12-10 10:42:14 -08:00
dev-intellij.txt
Default GERRIT_NOTEDB=ON
2018-11-02 16:28:37 -07:00
dev-plugins.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
dev-readme.txt
Remove gsql SSH command and program
2018-12-10 10:42:14 -08:00
dev-release-deploy-config.txt
Remove gwtjsonrpc library dependency
2018-12-19 10:13:09 -08:00
dev-release-jgit.txt
Provide a diff file to make it easier to deploy JGit snapshot
2016-08-31 11:13:47 +09:00
dev-release-subproject.txt
dev-release-subproject: Add 'performRelease' setting
2018-12-07 16:43:20 +09:00
dev-release.txt
Update plugin links in documentation
2018-09-28 16:07:43 +09:00
dev-rest-api.txt
gerrit-server: use hashed passwords for HTTP.
2017-02-28 09:09:33 +01:00
dev-stars.txt
Replace Mute/Unmute by Mark as Reviewed/Unreviewed (Part 3)
2017-10-01 12:38:18 +00:00
error-branch-not-found.txt
…
error-change-closed.txt
…
error-change-does-not-belong-to-project.txt
…
error-change-not-found.txt
…
error-change-upload-blocked.txt
…
error-commit-already-exists.txt
…
error-contains-banned-commit.txt
…
error-has-duplicates.txt
Fix some legacy-style titles in documentation
2016-07-08 13:45:28 +02:00
error-invalid-author.txt
…
error-invalid-changeid-line.txt
…
error-invalid-committer.txt
…
error-messages.txt
Deprecate pushing to refs/changes
2018-01-26 09:06:16 +01:00
error-missing-changeid.txt
ReceiveCommits: uniformize commit validation error messages.
2018-08-29 12:48:24 +09:00
error-missing-subject.txt
ReceiveCommits: uniformize commit validation error messages.
2018-08-29 12:48:24 +09:00
error-multiple-changeid-lines.txt
ReceiveCommits: uniformize commit validation error messages.
2018-08-29 12:48:24 +09:00
error-no-common-ancestry.txt
…
error-no-new-changes.txt
Clarify documentation of "no new changes" error message
2018-01-26 08:49:52 +09:00
error-non-fast-forward.txt
…
error-not-a-gerrit-administrator.txt
…
error-not-allowed-to-upload-merges.txt
…
error-not-permitted-to-create.txt
…
error-not-signed-off-by.txt
…
error-not-valid-ref.txt
…
error-permission-denied.txt
Documentation: Also consider the use of kerberos authentication over SSH
2017-08-28 01:44:52 +02:00
error-prohibited-by-gerrit.txt
Rename 'Push Annotated/Signed Tag' permission to 'Create Annotated/Signed Tag'
2016-09-08 13:50:04 +09:00
error-project-not-found.txt
…
error-push-fails-due-to-commit-message.txt
…
error-push-refschanges-not-allowed.txt
Deprecate pushing to refs/changes
2018-01-26 09:06:16 +01:00
error-same-change-id-in-multiple-changes.txt
…
error-too-many-commits.txt
Add limit to number of commits that ReceiveCommits will validate
2017-08-31 12:19:58 -04:00
error-upload-denied.txt
Fix some legacy-style titles in documentation
2016-07-08 13:45:28 +02:00
i18n-readme.txt
…
index.txt
Add QuotaBackend and QuotaEnforcer extension point
2018-12-04 13:23:18 +01:00
install-j2ee.txt
install-j2ee.txt: Remove references to ReviewDb
2018-12-11 09:58:58 +01:00
install.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
intro-gerrit-walkthrough.txt
Merge branch 'stable-2.15'
2018-06-13 16:20:48 +09:00
intro-how-gerrit-works.txt
Fix the display of images in intro-how-gerrit-works.txt
2018-09-18 11:12:35 -07:00
intro-project-owner.txt
Update plugin links in documentation
2018-09-28 16:07:43 +09:00
intro-quick.txt
Edits to intro-quick.txt and intro-how-gerrit-works.txt
2018-07-20 16:08:55 -07:00
intro-rockstar.txt
Add intro to documentation to describe the rationale of Gerrit code review.
2018-08-03 12:01:36 -07:00
intro-user.txt
Merge branch 'stable-2.15'
2018-10-16 08:30:47 +09:00
js-api.txt
Create gr-confirm-submit-dialog component
2018-06-20 12:05:01 -07:00
json.txt
Add hashtags to events and query results
2018-07-17 07:08:16 +02:00
linux-quickstart.txt
linux-quickstart: Remove leftover conflict marker
2018-08-23 12:30:31 +09:00
metrics.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
note-db.txt
Merge branch 'stable-2.15' into master
2018-02-07 15:04:41 -05:00
pg-plugin-admin-api.txt
Add API for defining new admin menu links from plugins
2018-03-30 16:38:17 -07:00
pg-plugin-change-metadata-api.txt
Plugin API for label score updates
2018-04-06 15:24:56 -07:00
pg-plugin-dev.txt
Add restApi.getVersion() method to plugin REST API
2018-04-24 10:31:40 -07:00
pg-plugin-endpoints.txt
Create gr-confirm-submit-dialog component
2018-06-20 12:05:01 -07:00
pg-plugin-migration.txt
Merge branch 'stable-2.15'
2018-01-25 01:57:07 +00:00
pg-plugin-repo-api.txt
Rename projects admin interface to repo
2017-12-27 21:40:31 +00:00
pg-plugin-rest-api.txt
Add restApi.getVersion() method to plugin REST API
2018-04-24 10:31:40 -07:00
pg-plugin-settings-api.txt
Support for .settingsScreen() plugin API
2018-01-04 15:59:48 -08:00
pg-plugin-styling.txt
Update PolyGerrit plugin documentation
2018-01-10 23:41:09 +00:00
pgm-daemon.txt
pgm-daemon.txt: Remove description of slave setup
2019-01-11 14:44:23 -08:00
pgm-index.txt
Remove gsql SSH command and program
2018-12-10 10:42:14 -08:00
pgm-init.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
pgm-LocalUsernamesToLowerCase.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
pgm-MigrateAccountPatchReviewDb.txt
Fix account_patch_reviews for mysql
2018-02-15 21:40:22 +00:00
pgm-passwd.txt
Gerrit command line utility to set/update secure.config
2017-01-12 00:25:25 +00:00
pgm-prolog-shell.txt
Use "gerrit" as the Gerrit user instead of "gerrit2"
2017-07-04 21:20:47 +09:00
pgm-reindex.txt
Remove --dry-run option from reindex command documentation
2016-07-08 15:26:42 +02:00
pgm-rulec.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00
pgm-SwitchSecureStore.txt
Some more broken synopsis formattings in documentation
2016-07-08 13:47:29 +02:00
project-configuration.txt
Move docs about project state to "config-project-config.txt"
2019-01-15 18:22:49 +01:00
prolog-change-facts.txt
Remove current_user predicates
2018-02-16 14:04:01 +00:00
prolog-cookbook.txt
Fix Prolog's example 10 in documentation
2018-06-13 12:30:13 +00:00
quota.txt
Add REST API quota checks
2018-12-04 14:46:51 +01:00
replace_macros.py
Add support for Documentation search
2018-11-12 19:00:57 +00:00
rest-api-access.txt
Merge branch 'stable-2.15'
2018-09-12 13:27:01 +09:00
rest-api-accounts.txt
Merge "Merge branch 'stable-2.15'"
2018-09-17 16:42:00 +00:00
rest-api-changes.txt
Merge branch 'stable-2.16'
2019-01-07 17:30:08 -05:00
rest-api-config.txt
Remove GWT UI
2018-11-13 15:06:26 -08:00
rest-api-documentation.txt
Remove Buck based build
2017-01-23 12:44:58 +00:00
rest-api-groups.txt
Docs: Clarify that for external groups the name in GroupInfo can be missing
2018-04-17 11:15:06 +00:00
rest-api-plugins.txt
Disentangle ListPlugins and PluginLsCommand
2017-08-10 22:43:32 +01:00
rest-api-projects.txt
Merge branch 'stable-2.16'
2018-12-06 21:40:22 +09:00
rest-api.txt
Add REST API quota checks
2018-12-04 14:46:51 +01:00
user-change-cleanup.txt
…
user-changeid.txt
Discontinue draft workflow
2017-09-30 15:47:14 +02:00
user-dashboards.txt
…
user-inline-edit.txt
user-inline-edit: Fix anchor on "Modifying Changes" section
2018-10-09 23:34:55 +00:00
user-named-destinations.txt
…
user-named-queries.txt
…
user-notify.txt
Add Gerrit-Comment-In-Reply-To footer
2017-11-22 14:23:03 -08:00
user-request-tracing.txt
Support request tracing for REST calls by setting a header in the request
2018-09-10 10:27:32 +02:00
user-review-ui.txt
Fix broken sentence in description of unchanged file marker
2018-11-07 09:23:30 +01:00
user-search-accounts.txt
Add account predicate that checks if user can see a certain change
2018-03-25 13:55:14 +01:00
user-search-groups.txt
Add fields for members and subgroups to the group index
2017-09-13 14:57:46 +02:00
user-search-projects.txt
Add STATE field to ProjectIndex
2018-07-12 09:24:49 +02:00
user-search.txt
Support searching changes by file extension
2019-01-14 08:57:13 -08:00
user-signedoffby.txt
…
user-submodules.txt
Replace "the the" occurences with "the" (wrong repetition)
2018-04-19 09:30:07 +02:00
user-upload.txt
Update most documentation for NoteDb
2019-01-11 14:44:23 -08:00