Commit 409bef69 authored by Amy Qualls's avatar Amy Qualls Committed by Craig Norris

Move style guide to its own folder

In prep for splitting the style guide apart, move the file to its
own folder.
parent 7e423209
...@@ -173,7 +173,7 @@ See [database guidelines](database/index.md). ...@@ -173,7 +173,7 @@ See [database guidelines](database/index.md).
## Documentation guides ## Documentation guides
- [Writing documentation](documentation/index.md) - [Writing documentation](documentation/index.md)
- [Documentation style guide](documentation/styleguide.md) - [Documentation style guide](documentation/styleguide/index.md)
- [Markdown](../user/markdown.md) - [Markdown](../user/markdown.md)
## Internationalization (i18n) guides ## Internationalization (i18n) guides
......
...@@ -146,7 +146,7 @@ Keep the following in mind when submitting merge requests: ...@@ -146,7 +146,7 @@ Keep the following in mind when submitting merge requests:
reviewers. reviewers.
- If the code quality is found to not meet GitLab’s standards, the merge request reviewer will - 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: provide guidance and refer the author to our:
- [Documentation](../documentation/styleguide.md) style guide. - [Documentation](../documentation/styleguide/index.md) style guide.
- Code style guides. - Code style guides.
- Sometimes style guides will be followed but the code will lack structural integrity, or the - 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, reviewer will have reservations about the code’s overall quality. When there is a reservation,
......
...@@ -122,7 +122,7 @@ We're following [Ciro Santilli's Markdown Style Guide](https://cirosantilli.com/ ...@@ -122,7 +122,7 @@ We're following [Ciro Santilli's Markdown Style Guide](https://cirosantilli.com/
## Documentation ## Documentation
See the dedicated [Documentation Style Guide](../documentation/styleguide.md). See the dedicated [Documentation Style Guide](../documentation/styleguide/index.md).
## Python ## Python
......
...@@ -30,7 +30,7 @@ See how to document them below, according to the state of the flag: ...@@ -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 that can be enabled or disabled for a single project](#features-enabled-by-project).
- [Features with the feature flag removed](#features-with-flag-removed). - [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 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, 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. therefore, it indicates that it cannot be done by regular users of GitLab.com.
......
...@@ -67,7 +67,7 @@ Set up the section with the following: ...@@ -67,7 +67,7 @@ Set up the section with the following:
``` ```
- Include a screenshot of the result in the GraphiQL explorer. Follow the naming - 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 - 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. example is something that readers can do on their own deployments.
- Include a link to the [GraphQL API resources](../../api/graphql/reference/index.md). - Include a link to the [GraphQL API resources](../../api/graphql/reference/index.md).
......
...@@ -11,7 +11,7 @@ GitLab's documentation is [intended as the single source of truth (SSOT)](https: ...@@ -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: 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. - [Structure and template](structure.md) - Learn the typical parts of a doc page and how to write each one.
- [Documentation process](workflow.md). - [Documentation process](workflow.md).
- [Markdown Guide](../../user/markdown.md) - A reference for all Markdown syntax supported by GitLab. - [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 ...@@ -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) [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. 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 ## 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 ## Metadata
...@@ -229,7 +229,7 @@ Things to note: ...@@ -229,7 +229,7 @@ Things to note:
it in for `workflow/lfs/lfs_administration` and `lfs/lfs_administration` it in for `workflow/lfs/lfs_administration` and `lfs/lfs_administration`
and will print the file and the line where this file is mentioned. 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 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 - 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`. built-in help page, which is why we omit it in `git grep`.
- Use the checklist on the "Change documentation location" MR description template. - Use the checklist on the "Change documentation location" MR description template.
......
...@@ -105,8 +105,8 @@ you can use in the API documentation. ...@@ -105,8 +105,8 @@ you can use in the API documentation.
CAUTION: **Caution:** CAUTION: **Caution:**
Do not use information for real users, URLs, or tokens. For documentation, refer to our 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), relevant style guide sections on [Fake user information](styleguide/index.md#fake-user-information),
[Fake URLs](styleguide.md#fake-urls), and [Fake tokens](styleguide.md#fake-tokens). [Fake URLs](styleguide/index.md#fake-urls), and [Fake tokens](styleguide/index.md#fake-tokens).
### Simple cURL command ### Simple cURL command
......
...@@ -10,7 +10,7 @@ description: What to include in GitLab documentation pages. ...@@ -10,7 +10,7 @@ description: What to include in GitLab documentation pages.
Use these standards to contribute content to the GitLab documentation. Use these standards to contribute content to the GitLab documentation.
Before getting started, familiarize yourself with [GitLab's Documentation guidelines](index.md) 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 ## Components of a documentation page
...@@ -39,7 +39,7 @@ pre-deployment and post-deployment tasks. ...@@ -39,7 +39,7 @@ pre-deployment and post-deployment tasks.
## Template for new docs ## 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: and create a new topic by using this template:
```markdown ```markdown
...@@ -160,9 +160,9 @@ commented out to help encourage others to add to it in the future. --> ...@@ -160,9 +160,9 @@ commented out to help encourage others to add to it in the future. -->
Notes: 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 - (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 ## Help and feedback section
......
This diff is collapsed.
This diff is collapsed.
...@@ -122,7 +122,7 @@ and you should make sure your version matches the version used by GitLab. ...@@ -122,7 +122,7 @@ and you should make sure your version matches the version used by GitLab.
## Local linters ## 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 added to documentation, [install documentation linters](#install-linters) and
[integrate them with your code editor](#configure-editors). [integrate them with your code editor](#configure-editors).
...@@ -137,7 +137,7 @@ At GitLab, we mostly use: ...@@ -137,7 +137,7 @@ At GitLab, we mostly use:
[certain rules](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#rules), and is [certain rules](https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#rules), and is
used by the `docs-lint` test. 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 [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 be made when selecting Markdown syntax for GitLab documentation. This tool helps catch deviations
from those guidelines. from those guidelines.
......
...@@ -58,7 +58,7 @@ To update GitLab documentation: ...@@ -58,7 +58,7 @@ To update GitLab documentation:
[GitLab Documentation guidelines](index.md) page. [GitLab Documentation guidelines](index.md) page.
1. Follow the described standards and processes listed on the page, including: 1. Follow the described standards and processes listed on the page, including:
- The [Structure and template](structure.md) page. - 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/). - 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). 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 ...@@ -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: 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. - 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 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). [DevOps stage group](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments).
...@@ -154,15 +154,15 @@ Remember: ...@@ -154,15 +154,15 @@ Remember:
Ensure the following if skipping an initial Technical Writer review: Ensure the following if skipping an initial Technical Writer review:
- That [product badges](styleguide.md#product-badges) are applied. - That [product badges](styleguide/index.md#product-badges) are applied.
- That the GitLab [version](styleguide.md#text-for-documentation-requiring-version-text) that - That the GitLab [version](styleguide/index.md#text-for-documentation-requiring-version-text) that
introduced the feature has been included. introduced the feature has been included.
- That changes to headings don't affect in-app hyperlinks. - That changes to headings don't affect in-app hyperlinks.
- Specific [user permissions](../../user/permissions.md) are documented. - Specific [user permissions](../../user/permissions.md) are documented.
- That new documents are linked from higher-level indexes, for discoverability. - That new documents are linked from higher-level indexes, for discoverability.
- Style guide is followed: - Style guide is followed:
- For [directories and files](styleguide.md#work-with-directories-and-files). - For [directories and files](styleguide/index.md#work-with-directories-and-files).
- For [images](styleguide.md#images). - For [images](styleguide/index.md#images).
Merge requests that change the location of documentation must always be reviewed by a Technical Merge requests that change the location of documentation must always be reviewed by a Technical
Writer prior to merging. Writer prior to merging.
...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -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 - **Write the code and the tests.**: As with any code, EE features should have
good test coverage to prevent regressions. good test coverage to prevent regressions.
- **Write documentation.**: Add documentation to the `doc/` directory. Describe - **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. the feature applies to.
- **Submit a MR to the `www-gitlab-com` project.**: Add the new feature to the - **Submit a MR to the `www-gitlab-com` project.**: Add the new feature to the
[EE features list](https://about.gitlab.com/features/). [EE features list](https://about.gitlab.com/features/).
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment