Merge branch 'aqualls-split-style-guide' into 'master'

Move style guide into subdir for future splitting

See merge request gitlab-org/gitlab!47237

doc/development/README.md

@@ -173,7 +173,7 @@ See [database guidelines](database/index.md).
 ## Documentation guides
 
 - [Writing documentation](documentation/index.md)
-- [Documentation style guide](documentation/styleguide.md)
+- [Documentation style guide](documentation/styleguide/index.md)
 - [Markdown](../user/markdown.md)
 
 ## Internationalization (i18n) guides

doc/development/contributing/index.md

@@ -146,7 +146,7 @@ Keep the following in mind when submitting merge requests:
   reviewers.
 - If the code quality is found to not meet GitLab’s standards, the merge request reviewer will
   provide guidance and refer the author to our:
-  - [Documentation](../documentation/styleguide.md) style guide.
+  - [Documentation](../documentation/styleguide/index.md) style guide.
   - Code style guides.
 - Sometimes style guides will be followed but the code will lack structural integrity, or the
   reviewer will have reservations about the code’s overall quality. When there is a reservation,

doc/development/contributing/style_guides.md

@@ -122,7 +122,7 @@ We're following [Ciro Santilli's Markdown Style Guide](https://cirosantilli.com/
 
 ## Documentation
 
-See the dedicated [Documentation Style Guide](../documentation/styleguide.md).
+See the dedicated [Documentation Style Guide](../documentation/styleguide/index.md).
 
 ## Python
 

doc/development/documentation/feature_flags.md

@@ -30,7 +30,7 @@ See how to document them below, according to the state of the flag:
 - [Features that can be enabled or disabled for a single project](#features-enabled-by-project).
 - [Features with the feature flag removed](#features-with-flag-removed).
 
-The [`**(CORE ONLY)**`](styleguide.md#product-badges) badge or equivalent for
+The [`**(CORE ONLY)**`](styleguide/index.md#product-badges) badge or equivalent for
 the feature's tier should be added to the line and heading that refers to
 enabling/disabling feature flags as Admin access is required to do so,
 therefore, it indicates that it cannot be done by regular users of GitLab.com.

doc/development/documentation/graphql_styleguide.md

@@ -67,7 +67,7 @@ Set up the section with the following:
   ```
 
 - Include a screenshot of the result in the GraphiQL explorer. Follow the naming
-  convention described in the [Save the image](styleguide.md#save-the-image) section of the Documentation style guide.
+  convention described in the [Save the image](styleguide/index.md#save-the-image) section of the Documentation style guide.
 - 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).

doc/development/documentation/index.md

@@ -11,7 +11,7 @@ GitLab's documentation is [intended as the single source of truth (SSOT)](https:
 
 In addition to this page, the following resources can help you craft and contribute to documentation:
 
-- [Style Guide](styleguide.md) - What belongs in the docs, language guidelines, Markdown standards to follow, links, and more.
+- [Style Guide](styleguide/index.md) - What belongs in the docs, language guidelines, Markdown standards to follow, links, and more.
 - [Structure and template](structure.md) - Learn the typical parts of a doc page and how to write each one.
 - [Documentation process](workflow.md).
 - [Markdown Guide](../../user/markdown.md) - A reference for all Markdown syntax supported by GitLab.
@@ -64,11 +64,11 @@ However, anyone can contribute [documentation improvements](workflow.md) that ar
 [GitLab docs](https://gitlab.com/gitlab-org/gitlab-docs) uses [GitLab Kramdown](https://gitlab.com/gitlab-org/gitlab_kramdown)
 as its Markdown rendering engine. See the [GitLab Markdown Guide](https://about.gitlab.com/handbook/markdown-guide/) for a complete Kramdown reference.
 
-Adhere to the [Documentation Style Guide](styleguide.md). If a style standard is missing, you are welcome to suggest one via a merge request.
+Adhere to the [Documentation Style Guide](styleguide/index.md). If a style standard is missing, you are welcome to suggest one via a merge request.
 
 ## Folder structure and files
 
-See the [Structure](styleguide.md#structure) section of the [Documentation Style Guide](styleguide.md).
+See the [Structure](styleguide/index.md#structure) section of the [Documentation Style Guide](styleguide/index.md).
 
 ## Metadata
 
@@ -229,7 +229,7 @@ Things to note:
   it in for `workflow/lfs/lfs_administration` and `lfs/lfs_administration`
   and will print the file and the line where this file is mentioned.
   You may ask why the two greps. Since [we use relative paths to link to
-  documentation](styleguide.md#links), sometimes it might be useful to search a path deeper.
+  documentation](styleguide/index.md#links), sometimes it might be useful to search a path deeper.
 - The `*.md` extension is not used when a document is linked to GitLab's
   built-in help page, which is why we omit it in `git grep`.
 - Use the checklist on the "Change documentation location" MR description template.

doc/development/documentation/restful_api_styleguide.md

@@ -105,8 +105,8 @@ you can use in the API documentation.
 
 CAUTION: **Caution:**
 Do not use information for real users, URLs, or tokens. For documentation, refer to our
-relevant style guide sections on [Fake user information](styleguide.md#fake-user-information),
-[Fake URLs](styleguide.md#fake-urls), and [Fake tokens](styleguide.md#fake-tokens).
+relevant style guide sections on [Fake user information](styleguide/index.md#fake-user-information),
+[Fake URLs](styleguide/index.md#fake-urls), and [Fake tokens](styleguide/index.md#fake-tokens).
 
 ### Simple cURL command
 

doc/development/documentation/structure.md

@@ -10,7 +10,7 @@ description: What to include in GitLab documentation pages.
 Use these standards to contribute content to the GitLab documentation.
 
 Before getting started, familiarize yourself with [GitLab's Documentation guidelines](index.md)
-and the [Documentation Style Guide](styleguide.md).
+and the [Documentation Style Guide](styleguide/index.md).
 
 ## Components of a documentation page
 
@@ -39,7 +39,7 @@ pre-deployment and post-deployment tasks.
 
 ## Template for new docs
 
-Follow the [folder structure and file name guidelines](styleguide.md#folder-structure-overview)
+Follow the [folder structure and file name guidelines](styleguide/index.md#folder-structure-overview)
 and create a new topic by using this template:
 
 ```markdown
@@ -160,9 +160,9 @@ commented out to help encourage others to add to it in the future. -->
 
 Notes:
 
-- (1): Apply the [tier badges](styleguide.md#product-badges) accordingly.
+- (1): Apply the [tier badges](styleguide/index.md#product-badges) accordingly.
 - (2): Apply the correct format for the
-       [GitLab version that introduces the feature](styleguide.md#gitlab-versions-and-tiers).
+       [GitLab version that introduces the feature](styleguide/index.md#gitlab-versions-and-tiers).
 ```
 
 ## Help and feedback section

doc/development/documentation/testing.md

@@ -122,7 +122,7 @@ and you should make sure your version matches the version used by GitLab.
 
 ## Local linters
 
-To help adhere to the [documentation style guidelines](styleguide.md), and improve the content
+To help adhere to the [documentation style guidelines](styleguide/index.md), and improve the content
 added to documentation, [install documentation linters](#install-linters) and
 [integrate them with your code editor](#configure-editors).
 
@@ -137,7 +137,7 @@ At GitLab, we mostly use:
 [certain rules](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#rules), and is
 used by the `docs-lint` test.
 
-Our [Documentation Style Guide](styleguide.md#markdown) and
+Our [Documentation Style Guide](styleguide/index.md#markdown) and
 [Markdown Guide](https://about.gitlab.com/handbook/markdown-guide/) elaborate on which choices must
 be made when selecting Markdown syntax for GitLab documentation. This tool helps catch deviations
 from those guidelines.

doc/development/documentation/workflow.md

@@ -58,7 +58,7 @@ To update GitLab documentation:
      [GitLab Documentation guidelines](index.md) page.
 1. Follow the described standards and processes listed on the page, including:
    - The [Structure and template](structure.md) page.
-   - The [Style Guide](styleguide.md).
+   - The [Style Guide](styleguide/index.md).
    - The [Markdown Guide](https://about.gitlab.com/handbook/markdown-guide/).
 1. Follow GitLab's [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines).
 
@@ -87,7 +87,7 @@ Anyone with Maintainer access to the relevant GitLab project can merge documenta
 Maintainers must make a good-faith effort to ensure that the content:
 
 - Is clear and sufficiently easy for the intended audience to navigate and understand.
-- Meets the [Documentation Guidelines](index.md) and [Style Guide](styleguide.md).
+- Meets the [Documentation Guidelines](index.md) and [Style Guide](styleguide/index.md).
 
 If the author or reviewer has any questions, they can mention the writer who is assigned to the relevant
 [DevOps stage group](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments).
@@ -154,15 +154,15 @@ Remember:
 
 Ensure the following if skipping an initial Technical Writer review:
 
-- That [product badges](styleguide.md#product-badges) are applied.
-- That the GitLab [version](styleguide.md#text-for-documentation-requiring-version-text) that
+- That [product badges](styleguide/index.md#product-badges) are applied.
+- That the GitLab [version](styleguide/index.md#text-for-documentation-requiring-version-text) that
   introduced the feature has been included.
 - That changes to headings don't affect in-app hyperlinks.
 - Specific [user permissions](../../user/permissions.md) are documented.
 - That new documents are linked from higher-level indexes, for discoverability.
 - Style guide is followed:
-  - For [directories and files](styleguide.md#work-with-directories-and-files).
-  - For [images](styleguide.md#images).
+  - For [directories and files](styleguide/index.md#work-with-directories-and-files).
+  - For [images](styleguide/index.md#images).
 
 Merge requests that change the location of documentation must always be reviewed by a Technical
 Writer prior to merging.

doc/development/ee_features.md

@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 - **Write the code and the tests.**: As with any code, EE features should have
   good test coverage to prevent regressions.
 - **Write documentation.**: Add documentation to the `doc/` directory. Describe
-  the feature and include screenshots, if applicable. Indicate [what editions](documentation/styleguide.md#product-badges)
+  the feature and include screenshots, if applicable. Indicate [what editions](documentation/styleguide/index.md#product-badges)
   the feature applies to.
 - **Submit a MR to the `www-gitlab-com` project.**: Add the new feature to the
   [EE features list](https://about.gitlab.com/features/).