diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/.linting/vale/styles/gitlab/Contractions.yml | 76 | ||||
| -rw-r--r-- | doc/api/projects.md | 12 | ||||
| -rw-r--r-- | doc/development/contributing/merge_request_workflow.md | 4 | ||||
| -rw-r--r-- | doc/development/documentation/styleguide.md | 6 | ||||
| -rw-r--r-- | doc/development/rake_tasks.md | 11 |
5 files changed, 106 insertions, 3 deletions
diff --git a/doc/.linting/vale/styles/gitlab/Contractions.yml b/doc/.linting/vale/styles/gitlab/Contractions.yml new file mode 100644 index 00000000000..0f31f6b6aa9 --- /dev/null +++ b/doc/.linting/vale/styles/gitlab/Contractions.yml @@ -0,0 +1,76 @@ +--- +# `extends` indicates the Vale extension point being used. +# Full list of styles: https://errata-ai.github.io/vale/styles/ +extends: substitution + +# Substitution rules can display the matched and suggested strings in the +# message shown to the user. The first use of %s prints the suggested option, +# and the second use of %s displays what was found in the text. +message: Use "%s" instead of "%s" in most cases. + +# Should a result be flagged as a suggestion, warning, or error? +# Results that fall below the MinAlertLevel set in +# https://gitlab.com/gitlab-org/gitlab/blob/master/.vale.ini won't be shown. +level: suggestion + +# Should a match be case-insensitive or case-sensitive? +# Acceptable values are 'true' or 'false' +ignorecase: true + +# Should this rule be limited to a specific scope? If yes, uncomment the line. +# Possible scopes: https://errata-ai.github.io/vale/formats/#available-scopes +# scope: heading + +# Should this rule ignore normal word boundaries, such as \b ? +# Acceptable values are 'true' or 'false' +nonword: false + +# What is the source for this rule? +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language + +# The 'swap' section provides a list of values, one per line, in the form of +# $bad: $good +swap: + + # Common contractions are ok + it is: it's + can not: can't + cannot: can't + do not: don't + have not: haven't + that is: that's + we are: we're + will not: won't + would not: wouldn't + you are: you're + you have: you've + + # Uncommon contractions are not ok + aren't: are not + couldn't: could not + didn't: did not + doesn't: does not + hasn't: has not + how'll: how will + how's: how is + isn't: is not + it'll: it will + shouldn't: should not + that'll: that will + they'll: they will + they're: they are + wasn't: was not + weren't: were not + we'll: we will + we've: we have + what's: what is + what'll: what will + when's: when is + when'll: when will + where's: where is + where'll: where will + who's: who is + who'll: who will + why's: why is + why'll: why will + diff --git a/doc/api/projects.md b/doc/api/projects.md index d67d8949571..ad1cc4ea1b7 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -129,6 +129,7 @@ When the user is authenticated and `simple` is not set this returns something li "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", @@ -205,6 +206,7 @@ When the user is authenticated and `simple` is not set this returns something li "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", @@ -371,6 +373,7 @@ This endpoint supports [keyset pagination](README.md#keyset-based-pagination) fo "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", @@ -447,6 +450,7 @@ This endpoint supports [keyset pagination](README.md#keyset-based-pagination) fo "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", @@ -584,6 +588,7 @@ Example response: "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", @@ -657,6 +662,7 @@ Example response: "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", @@ -774,6 +780,7 @@ GET /projects/:id "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "container_expiration_policy": { @@ -1260,6 +1267,7 @@ Example responses: "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", @@ -1342,6 +1350,7 @@ Example response: "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", @@ -1431,6 +1440,7 @@ Example response: "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", @@ -1594,6 +1604,7 @@ Example response: "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", @@ -1702,6 +1713,7 @@ Example response: "jobs_enabled": true, "wiki_enabled": true, "snippets_enabled": false, + "can_create_merge_request_in": true, "resolve_outdated_diff_discussions": false, "container_registry_enabled": false, "created_at": "2013-09-30T13:46:02Z", diff --git a/doc/development/contributing/merge_request_workflow.md b/doc/development/contributing/merge_request_workflow.md index e839ae0ea3a..8ba6cbf657d 100644 --- a/doc/development/contributing/merge_request_workflow.md +++ b/doc/development/contributing/merge_request_workflow.md @@ -15,8 +15,7 @@ to be marked as `Accepting Merge Requests`. Please include screenshots or wireframes of the proposed feature if it will also change the UI. Merge requests should be submitted to the appropriate project at GitLab.com, for example -[GitLab CE](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests), -[GitLab EE](https://gitlab.com/gitlab-org/gitlab/merge_requests), +[GitLab](https://gitlab.com/gitlab-org/gitlab/merge_requests), [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner/merge_requests), [GitLab Omnibus](https://gitlab.com/gitlab-org/omnibus-gitlab/merge_requests), etc. @@ -227,6 +226,7 @@ requirements. 1. [Changelog entry added](../changelog.md), if necessary. 1. Reviewed by relevant (UX/FE/BE/tech writing) reviewers and all concerns are addressed. 1. Merged by a project maintainer. +1. Create an issue in the [infrastructure issue tracker](https://gitlab.com/gitlab-com/gl-infra/infrastructure/issues) to inform the Infrastructure department when your contribution is changing default settings or introduces a new setting, if relevant. 1. Confirmed to be working in the [Canary stage](https://about.gitlab.com/handbook/engineering/#canary-testing) or on GitLab.com once the contribution is deployed. 1. Added to the [release post](https://about.gitlab.com/handbook/marketing/blog/release-posts/), if relevant. diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 063f2b74ce2..b361648b2f0 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -771,6 +771,9 @@ nicely on different mobile devices. To make things easier for the user, always add a full code block for things that can be useful to copy and paste, as they can easily do it with the button on code blocks. - Add a blank line above and below code blocks. +- When providing a shell command and its output, prefix the shell command with `$` and + leave a blank line between the command and the output. +- When providing a command without output, don't prefix the shell command with `$`. - For regular code blocks, always use a highlighting class corresponding to the language for better readability. Examples: @@ -795,7 +798,8 @@ nicely on different mobile devices. - To display raw Markdown instead of rendered Markdown, you can use triple backticks with `md`, like the `Markdown code` example above, unless you want to include triple backticks in the code block as well. In that case, use triple tildes (`~~~`) instead. -- [Syntax highlighting for code blocks](https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers) is available for many languages. +- [Syntax highlighting for code blocks](https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers) + is available for many languages. Use `shell` instead of `bash` or `sh` for shell output. - For a complete reference on code blocks, check the [Kramdown guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/#code-blocks). ## GitLab SVG icons diff --git a/doc/development/rake_tasks.md b/doc/development/rake_tasks.md index ff978ee2899..d9b2ace1b5b 100644 --- a/doc/development/rake_tasks.md +++ b/doc/development/rake_tasks.md @@ -54,6 +54,17 @@ By default, this seeds an average of 10 issues per week for the last 52 weeks per project. All issues will also be randomly labeled with team, type, severity, and priority. +#### Seeding groups with sub-groups + +You can seed groups with sub-groups that contain milestones/projects/issues +with the `gitlab:seed:group_seed` task: + +```shell +bin/rake "gitlab:seed:group_seed[subgroup_depth, username]" +``` + +Group are additionally seeded with epics if GitLab instance has epics feature available. + ### Automation If you're very sure that you want to **wipe the current database** and refill |