From 255fd0f72c842af763ecd85128491db4c281d73d Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Thu, 22 Oct 2020 00:11:15 +0000 Subject: [PATCH] Add latest changes from gitlab-org/gitlab@master --- CHANGELOG.md | 16 ++++ doc/.vale/gitlab/Admin.yml | 2 +- doc/.vale/gitlab/AlertBoxCaution.yml | 13 ++++ doc/.vale/gitlab/AlertBoxDanger.yml | 13 ++++ doc/.vale/gitlab/AlertBoxNoteTip.yml | 14 ++++ doc/.vale/gitlab/AlertBoxStyle.yml | 6 +- doc/development/README.md | 19 ++++- doc/development/documentation/styleguide.md | 83 --------------------- 8 files changed, 76 insertions(+), 90 deletions(-) create mode 100644 doc/.vale/gitlab/AlertBoxCaution.yml create mode 100644 doc/.vale/gitlab/AlertBoxDanger.yml create mode 100644 doc/.vale/gitlab/AlertBoxNoteTip.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index 84efdd7ef9f..c15f7b1d784 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1234,6 +1234,22 @@ entry. - Expand the visible highlight for collapsed diffs (re: !41393). !42343 +## 13.3.8 (2020-10-21) + +### Fixed (2 changes) + +- Make SSH keys publicly accessible. !42288 +- Revert required encryption on CI runner tokens. !42623 + +### Added (1 change) + +- Add missing fontawesome file icon classes. !43091 + +### Other (1 change) + +- GitLab-managed apps: Use GitLab's repo as replacement for the Helm stable repo. !44875 + + ## 13.3.4 (2020-09-02) ### Security (1 change) diff --git a/doc/.vale/gitlab/Admin.yml b/doc/.vale/gitlab/Admin.yml index 27a703c30c3..6d01882138a 100644 --- a/doc/.vale/gitlab/Admin.yml +++ b/doc/.vale/gitlab/Admin.yml @@ -10,4 +10,4 @@ link: https://docs.gitlab.com/ee/development/documentation/styleguide.html level: warning ignorecase: true swap: - 'admin ?\w*': '(?:Admin Area|[Aa]dminist(ration|rator|er))' + 'admin ?\w*': '(?:Admin Area|[Aa]dminist(ration|rator|er|rative))' diff --git a/doc/.vale/gitlab/AlertBoxCaution.yml b/doc/.vale/gitlab/AlertBoxCaution.yml new file mode 100644 index 00000000000..ff51bf4f993 --- /dev/null +++ b/doc/.vale/gitlab/AlertBoxCaution.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.AlertBoxCaution +# +# Makes sure DANGER: alert boxes follow standard formatting. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: substitution +message: "CAUTION: alert boxes must be of the format 'CAUTION: **Caution:**'. 'Caution' can be replaced with 'Warning' or 'Important'." +level: warning +nonword: true +scope: raw +swap: + 'CAUTION: *?\*\*.*\*\*': 'CAUTION: \*\*(?:Caution|Warning|Important):\*\*' diff --git a/doc/.vale/gitlab/AlertBoxDanger.yml b/doc/.vale/gitlab/AlertBoxDanger.yml new file mode 100644 index 00000000000..98f97b4c9b7 --- /dev/null +++ b/doc/.vale/gitlab/AlertBoxDanger.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.AlertBoxDanger +# +# Makes sure DANGER: alert boxes follow standard formatting. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: substitution +message: "DANGER: alert boxes must be of the format 'DANGER: **Warning:**'. 'Warning' can be replaced with 'Important', 'Deprecated', or 'Required'." +level: warning +nonword: true +scope: raw +swap: + 'DANGER: *?\*\*.*\*\*': 'DANGER: \*\*(?:Warning|Important|Deprecated|Required):\*\*' diff --git a/doc/.vale/gitlab/AlertBoxNoteTip.yml b/doc/.vale/gitlab/AlertBoxNoteTip.yml new file mode 100644 index 00000000000..f2418c5d2d1 --- /dev/null +++ b/doc/.vale/gitlab/AlertBoxNoteTip.yml @@ -0,0 +1,14 @@ +--- +# Error: gitlab.AlertBoxNoteTip +# +# Makes sure NOTE: and TIP: alert boxes follow standard formatting. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: substitution +message: "NOTE: and TIP: alert boxes must be of the format 'NOTE: **Note:**' or 'TIP: **Tip:**" +level: warning +nonword: true +scope: raw +swap: + 'NOTE: *?\*\*.*\*\*': 'NOTE: \*\*Note:\*\*' + 'TIP: *?\*\*.*\*\*': 'TIP: \*\*Tip:\*\*' diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml index 06743d95ea9..0f7e163409a 100644 --- a/doc/.vale/gitlab/AlertBoxStyle.yml +++ b/doc/.vale/gitlab/AlertBoxStyle.yml @@ -3,9 +3,7 @@ # # Makes sure alert boxes follow standard formatting. # -# Checks for 4 known issues: -# - Alert boxes with no colon, or colon outside the bold text -# - Known incorrect capitalization of the most commonly used alert box text +# Checks for 2 formatting issues: # - Alert boxes with the note text on the same line # - Alert boxes using blockquote formatting, like "> **Note:**" # @@ -16,7 +14,5 @@ link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert level: error scope: raw raw: - - '((NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*)|' - - '((NOTE: \*\*(NOTE|note):\*\*)|(TIP: \*\*(TIP|tip):\*\*)|(CAUTION: \*\*(CAUTION|caution):\*\*)|(DANGER: \*\*(DANGER|danger):\*\*))|' - '((NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)|' - '((\n[> ]*(\*){1,2}(NOTE|Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger):(\*){1,2}))' diff --git a/doc/development/README.md b/doc/development/README.md index 7b8a5cd5f75..bc88c48baa1 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -1,6 +1,10 @@ --- comments: false -description: 'Learn how to contribute to GitLab.' +type: index, dev +stage: none +group: Development +info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines" +description: "Development Guidelines: learn how to contribute to GitLab." --- # Contributor and Development Docs @@ -60,6 +64,19 @@ Complementary reads: - [Patch release process for developers](https://gitlab.com/gitlab-org/release/docs/blob/master/general/patch/process.md#process-for-developers) - [Adding a new service component to GitLab](adding_service_component.md) +### Development guidelines review + +When you submit a change to GitLab's development guidelines, request a review +from: + +- A member of your team or group, to check for technical accuracy. +- For **significant** changes or proposals, request review from: + - Engineering managers (FE, BE, DB, Security, UX, and others), according to the subject or process you're proposing. + - The VP of Development (DRI) ([@clefelhocz1](https://gitlab.com/clefelhocz1)), for + final approval of the new or changed guidelines. +- The [Technical Writer assigned to dev guidelines](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines), + to review the content for consistency and adherence to documentation guidelines. + ## UX and Frontend guides - [GitLab Design System](https://design.gitlab.com/) for building GitLab with existing CSS styles and elements diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index cd910b64b0f..31466e7717f 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -1984,86 +1984,3 @@ steps aren't required, consider setting up a [table](#tables) with headers of Learn how to [document features deployed behind flags](feature_flags.md). For guidance on developing GitLab with feature flags, see [Feature flags in development of GitLab](../feature_flags/index.md). - -## GraphQL API - -GraphQL APIs are different from [RESTful APIs](restful_api_styleguide.md). Reference -information is generated in our [GraphQL reference](../../api/graphql/reference/index.md). - -However, it's helpful to include examples on how to use GraphQL for different -*use cases*, with samples that readers can use directly in the -[GraphiQL explorer](../api_graphql_styleguide.md#graphiql). - -This section describes the steps required to add your GraphQL examples to -GitLab documentation. - -### Add a dedicated GraphQL page - -To create a dedicated GraphQL page, create a new `.md` file in the -`doc/api/graphql/` directory. Give that file a functional name, such as -`import_from_specific_location.md`. - -### Start the page with an explanation - -Include a page title that describes the GraphQL functionality in a few words, -such as: - -```markdown -# Search for [substitute kind of data] -``` - -Describe the search. One sentence may be all you need. More information may -help readers learn how to use the example for their GitLab deployments. - -### Include a procedure using the GraphiQL explorer - -The GraphiQL explorer can help readers test queries with working deployments. -Set up the section with the following: - -- Use the following title: - - ```markdown - ## Set up the GraphiQL explorer - ``` - -- Include a code block with the query that anyone can include in their - instance of the GraphiQL explorer: - - ````markdown - ```graphql - query { - - } - ``` - ```` - -- Tell the user what to do: - - ```markdown - 1. Open the GraphiQL explorer tool in the following URL: `https://gitlab.com/-/graphql-explorer`. - 1. Paste the `query` listed above into the left window of your GraphiQL explorer tool. - 1. Select Play to get the result shown here: - ``` - -- Include a screenshot of the result in the GraphiQL explorer. Follow the naming - convention described in the [Save the image](#save-the-image) section. -- Follow up with an example of what you can do with the output. Make sure the - example is something that readers can do on their own deployments. -- Include a link to the [GraphQL API resources](../../api/graphql/reference/index.md). - -### Add the GraphQL example to the Table of Contents - -You'll need to open a second MR, against the [GitLab documentation repository](https://gitlab.com/gitlab-org/gitlab-docs/). - -We store our Table of Contents in the `default-nav.yaml` file, in the -`content/_data` subdirectory. You can find the GraphQL section under the -following line: - -```yaml -- category_title: GraphQL -``` - -Be aware that CI tests for that second MR will fail with a bad link until the -main MR that adds the new GraphQL page is merged. - -And that's all you need!