Merge branch 'bvl-docs-add-reserved-names-to-docs' into 'master'
Add reserved names to docs See merge request !13583
This commit is contained in:
Achilleas Pipinellis
commit
36ba84cb94
4 changed files with 122 additions and 6 deletions
|
|
@ -1,5 +1,9 @@
|
|||
# How to create a project in GitLab
|
||||
|
||||
>**Notes:**
|
||||
- For a list of words that are not allowed to be used as project names see the
|
||||
[reserved names][reserved].
|
||||
|
||||
1. In your dashboard, click the green **New project** button or use the plus
|
||||
icon in the upper right corner of the navigation bar.
|
||||
|
||||
|
|
@ -26,3 +30,4 @@
|
|||
1. Click **Create project**.
|
||||
|
||||
[import it]: ../workflow/importing/README.md
|
||||
[reserved]: ../user/reserved_names.md
|
||||
|
|
|
|||
|
|
@ -57,6 +57,10 @@ By doing so:
|
|||
|
||||
## Create a new group
|
||||
|
||||
> **Notes:**
|
||||
- For a list of words that are not allowed to be used as group names see the
|
||||
[reserved names][reserved].
|
||||
|
||||
You can create a group in GitLab from:
|
||||
|
||||
1. The Groups page: expand the left menu, click **Groups**, and click the green button **New group**:
|
||||
|
|
@ -213,4 +217,5 @@ for the group (GitLab admins only, available in [GitLab Enterprise Edition Start
|
|||
- **Pipelines quota**: keep track of the [pipeline quota](../admin_area/settings/continuous_integration.md) for the group
|
||||
|
||||
[permissions]: ../permissions.md#permissions
|
||||
[ee]: https://about.gitlab.com/products/
|
||||
[ee]: https://about.gitlab.com/products/
|
||||
[reserved]: ../reserved_names.md
|
||||
|
|
|
|||
|
|
@ -83,10 +83,7 @@ structure.
|
|||
- You need to be an Owner of a group in order to be able to create
|
||||
a subgroup. For more information check the [permissions table][permissions].
|
||||
- For a list of words that are not allowed to be used as group names see the
|
||||
[`path_regex.rb` file][reserved] under the `TOP_LEVEL_ROUTES`, `PROJECT_WILDCARD_ROUTES` and `GROUP_ROUTES` lists:
|
||||
- `TOP_LEVEL_ROUTES`: are names that are reserved as usernames or top level groups
|
||||
- `PROJECT_WILDCARD_ROUTES`: are names that are reserved for child groups or projects.
|
||||
- `GROUP_ROUTES`: are names that are reserved for all groups or projects.
|
||||
[reserved names][reserved].
|
||||
|
||||
To create a subgroup:
|
||||
|
||||
|
|
@ -175,5 +172,5 @@ Here's a list of what you can't do with subgroups:
|
|||
|
||||
[ce-2772]: https://gitlab.com/gitlab-org/gitlab-ce/issues/2772
|
||||
[permissions]: ../../permissions.md#group
|
||||
[reserved]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/gitlab/path_regex.rb
|
||||
[reserved]: ../../reserved_names.md
|
||||
[issue]: https://gitlab.com/gitlab-org/gitlab-ce/issues/30472#note_27747600
|
||||
|
|
|
|||
109
doc/user/reserved_names.md
Normal file
109
doc/user/reserved_names.md
Normal file
|
|
@ -0,0 +1,109 @@
|
|||
# Reserved project and group names
|
||||
|
||||
Not all project & group names are allowed because they would conflict with
|
||||
existing routes used by GitLab.
|
||||
|
||||
For a list of words that are not allowed to be used as group or project names, see the
|
||||
[`path_regex.rb` file][reserved] under the `TOP_LEVEL_ROUTES`, `PROJECT_WILDCARD_ROUTES` and `GROUP_ROUTES` lists:
|
||||
- `TOP_LEVEL_ROUTES`: are names that are reserved as usernames or top level groups
|
||||
- `PROJECT_WILDCARD_ROUTES`: are names that are reserved for child groups or projects.
|
||||
- `GROUP_ROUTES`: are names that are reserved for all groups or projects.
|
||||
|
||||
## Reserved project names
|
||||
|
||||
It is currently not possible to create a project with the following names:
|
||||
|
||||
- -
|
||||
- badges
|
||||
- blame
|
||||
- blob
|
||||
- builds
|
||||
- commits
|
||||
- create
|
||||
- create_dir
|
||||
- edit
|
||||
- environments/folders
|
||||
- files
|
||||
- find_file
|
||||
- gitlab-lfs/objects
|
||||
- info/lfs/objects
|
||||
- new
|
||||
- preview
|
||||
- raw
|
||||
- refs
|
||||
- tree
|
||||
- update
|
||||
- wikis
|
||||
|
||||
## Reserved group names
|
||||
|
||||
Currently the following names are reserved as top level groups:
|
||||
|
||||
- 503.html
|
||||
- -
|
||||
- .well-known
|
||||
- 404.html
|
||||
- 422.html
|
||||
- 500.html
|
||||
- 502.html
|
||||
- abuse_reports
|
||||
- admin
|
||||
- api
|
||||
- apple-touch-icon-precomposed.png
|
||||
- apple-touch-icon.png
|
||||
- files
|
||||
- assets
|
||||
- autocomplete
|
||||
- ci
|
||||
- dashboard
|
||||
- deploy.html
|
||||
- explore
|
||||
- favicon.ico
|
||||
- groups
|
||||
- header_logo_dark.png
|
||||
- header_logo_light.png
|
||||
- health_check
|
||||
- help
|
||||
- import
|
||||
- invites
|
||||
- jwt
|
||||
- koding
|
||||
- notification_settings
|
||||
- oauth
|
||||
- profile
|
||||
- projects
|
||||
- public
|
||||
- robots.txt
|
||||
- s
|
||||
- search
|
||||
- sent_notifications
|
||||
- slash-command-logo.png
|
||||
- snippets
|
||||
- u
|
||||
- unicorn_test
|
||||
- unsubscribes
|
||||
- uploads
|
||||
- users
|
||||
|
||||
These group names are unavailable as subgroup names:
|
||||
|
||||
- -
|
||||
- activity
|
||||
- analytics
|
||||
- audit_events
|
||||
- avatar
|
||||
- edit
|
||||
- group_members
|
||||
- hooks
|
||||
- issues
|
||||
- labels
|
||||
- ldap
|
||||
- ldap_group_links
|
||||
- merge_requests
|
||||
- milestones
|
||||
- notification_setting
|
||||
- pipeline_quota
|
||||
- projects
|
||||
- subgroups
|
||||
|
||||
[reserved]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/gitlab/path_regex.rb
|
||||
Loading…
Reference in a new issue