debian-mirror-gitlab/doc/development/documentation/index.md

553 lines
26 KiB
Markdown
Raw Normal View History

2018-11-08 19:23:39 +05:30
---
2021-01-03 14:25:43 +05:30
stage: none
group: Documentation Guidelines
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2018-11-08 19:23:39 +05:30
description: Learn how to contribute to GitLab Documentation.
---
# GitLab Documentation guidelines
2021-02-22 17:27:13 +05:30
The GitLab documentation is [intended as the single source of truth (SSOT)](https://about.gitlab.com/handbook/documentation/) for information about how to configure, use, and troubleshoot GitLab. The documentation contains use cases and usage instructions for every GitLab feature, organized by product area and subject. This includes topics and workflows that span multiple GitLab features, and the use of GitLab with other applications.
2018-11-08 19:23:39 +05:30
2020-05-24 23:13:21 +05:30
In addition to this page, the following resources can help you craft and contribute to documentation:
2019-02-15 15:39:39 +05:30
2021-01-29 00:20:46 +05:30
- [Style Guide](styleguide/index.md) - What belongs in the docs, language guidelines, Markdown standards to follow, links, and more.
2019-02-15 15:39:39 +05:30
- [Structure and template](structure.md) - Learn the typical parts of a doc page and how to write each one.
2019-12-21 20:55:43 +05:30
- [Documentation process](workflow.md).
- [Markdown Guide](../../user/markdown.md) - A reference for all Markdown syntax supported by GitLab.
- [Site architecture](site_architecture/index.md) - How <https://docs.gitlab.com> is built.
2020-05-24 23:13:21 +05:30
- [Documentation for feature flags](feature_flags.md) - How to write and update documentation for GitLab features deployed behind feature flags.
2018-11-08 19:23:39 +05:30
2019-07-31 22:56:46 +05:30
## Source files and rendered web locations
2018-11-08 19:23:39 +05:30
2020-04-08 14:13:33 +05:30
Documentation for GitLab, GitLab Runner, Omnibus GitLab, and Charts is published to <https://docs.gitlab.com>. Documentation for GitLab is also published within the application at `/help` on the domain of the GitLab instance.
2019-12-21 20:55:43 +05:30
At `/help`, only help for your current edition and version is included. Help for other versions is available at <https://docs.gitlab.com/archives/>.
2018-11-08 19:23:39 +05:30
2019-07-31 22:56:46 +05:30
The source of the documentation exists within the codebase of each GitLab application in the following repository locations:
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
| Project | Path |
| --- | --- |
2019-12-04 20:38:33 +05:30
| [GitLab](https://gitlab.com/gitlab-org/gitlab/) | [`/doc`](https://gitlab.com/gitlab-org/gitlab/tree/master/doc) |
2019-02-15 15:39:39 +05:30
| [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner/) | [`/docs`](https://gitlab.com/gitlab-org/gitlab-runner/tree/master/docs) |
2020-07-28 23:09:34 +05:30
| [Omnibus GitLab](https://gitlab.com/gitlab-org/omnibus-gitlab/) | [`/doc`](https://gitlab.com/gitlab-org/omnibus-gitlab/tree/master/doc) |
2019-12-21 20:55:43 +05:30
| [Charts](https://gitlab.com/gitlab-org/charts/gitlab) | [`/doc`](https://gitlab.com/gitlab-org/charts/gitlab/tree/master/doc) |
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
Documentation issues and merge requests are part of their respective repositories and all have the label `Documentation`.
2020-01-01 13:55:28 +05:30
### Branch naming
The [CI pipeline for the main GitLab project](../pipelines.md) is configured to automatically
run only the jobs that match the type of contribution. If your contribution contains
2021-02-22 17:27:13 +05:30
**only** documentation changes, then only documentation-related jobs run, and
the pipeline completes much faster than a code contribution.
2020-01-01 13:55:28 +05:30
If you are submitting documentation-only changes to Runner, Omnibus, or Charts,
the fast pipeline is not determined automatically. Instead, create branches for
docs-only merge requests using the following guide:
| Branch name | Valid example |
|:----------------------|:-----------------------------|
| Starting with `docs/` | `docs/update-api-issues` |
| Starting with `docs-` | `docs-update-api-issues` |
| Ending in `-docs` | `123-update-api-issues-docs` |
2019-02-15 15:39:39 +05:30
## Contributing to docs
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
[Contributions to GitLab docs](workflow.md) are welcome from the entire GitLab community.
2018-11-08 19:23:39 +05:30
2021-01-03 14:25:43 +05:30
To ensure that GitLab docs are current, there are special processes and responsibilities for all [feature changes](workflow.md), that is development work that impacts the appearance, usage, or administration of a feature.
2019-02-15 15:39:39 +05:30
2021-01-03 14:25:43 +05:30
However, anyone can contribute [documentation improvements](workflow.md) that are not associated with a feature change. For example, adding a new doc on how to accomplish a use case that's already possible with GitLab or with third-party tools and GitLab.
2018-11-08 19:23:39 +05:30
## Markdown and styles
2019-09-30 21:07:59 +05:30
[GitLab docs](https://gitlab.com/gitlab-org/gitlab-docs) uses [GitLab Kramdown](https://gitlab.com/gitlab-org/gitlab_kramdown)
2020-06-23 00:09:42 +05:30
as its Markdown rendering engine. See the [GitLab Markdown Guide](https://about.gitlab.com/handbook/markdown-guide/) for a complete Kramdown reference.
2018-11-08 19:23:39 +05:30
2021-01-29 00:20:46 +05:30
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.
2018-11-08 19:23:39 +05:30
2019-07-31 22:56:46 +05:30
## Folder structure and files
2021-01-29 00:20:46 +05:30
See the [Structure](styleguide/index.md#structure) section of the [Documentation Style Guide](styleguide/index.md).
2019-07-31 22:56:46 +05:30
2020-06-23 00:09:42 +05:30
## Metadata
To provide additional directives or useful information, we add metadata in YAML
2020-07-28 23:09:34 +05:30
format to the beginning of each product documentation page (YAML front matter).
All values are treated as strings and are only used for the
[docs website](site_architecture/index.md).
### Stage and group metadata
Each page should ideally have metadata related to the stage and group it
belongs to, as well as an information block as described below:
2021-02-22 17:27:13 +05:30
- `stage`: The [Stage](https://about.gitlab.com/handbook/product/categories/#devops-stages)
2020-07-28 23:09:34 +05:30
to which the majority of the page's content belongs.
- `group`: The [Group](https://about.gitlab.com/company/team/structure/#product-groups)
to which the majority of the page's content belongs.
- `info`: The following line, which provides direction to contributors regarding
how to contact the Technical Writer associated with the page's Stage and
Group:
```plaintext
To determine the technical writer assigned to the Stage/Group
associated with this page, see
2021-02-22 17:27:13 +05:30
https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-07-28 23:09:34 +05:30
```
2020-06-23 00:09:42 +05:30
For example, the following metadata would be at the beginning of a product
documentation page whose content is primarily associated with the Audit Events
feature:
```yaml
---
stage: Monitor
group: APM
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-06-23 00:09:42 +05:30
---
```
2020-11-24 15:15:51 +05:30
### Document type metadata
2020-07-28 23:09:34 +05:30
Originally discussed in [this epic](https://gitlab.com/groups/gitlab-org/-/epics/1280),
2020-11-24 15:15:51 +05:30
each page should have a metadata tag called `type`. It can be one or more of the
following:
- `index`: It consists mostly of a list of links to other pages.
[Example page](../../README.md).
- `concepts`: The background or context of a subject.
[Example page](../../topics/autodevops/index.md).
- `howto`: Specific use case instructions.
[Example page](../../ssh/README.md).
- `tutorial`: Learn a process/concept by doing.
[Example page](../../gitlab-basics/start-using-git.md).
- `reference`: A collection of information used as a reference to use a feature
or a functionality. [Example page](../../ci/yaml/README.md).
2020-07-28 23:09:34 +05:30
### Redirection metadata
The following metadata should be added when a page is moved to another location:
2020-06-23 00:09:42 +05:30
- `redirect_to`: The relative path and filename (with an `.md` extension) of the
location to which visitors should be redirected for a moved page.
2021-01-03 14:25:43 +05:30
[Learn more](#move-or-rename-a-page).
2020-06-23 00:09:42 +05:30
- `disqus_identifier`: Identifier for Disqus commenting system. Used to keep
comments with a page that's been moved to a new URL.
[Learn more](#redirections-for-pages-with-disqus-comments).
2020-07-28 23:09:34 +05:30
### Comments metadata
The [docs website](site_architecture/index.md) has comments (provided by Disqus)
enabled by default. In case you want to disable them (for example in index pages),
set it to `false`:
```yaml
---
comments: false
---
```
### Additional page metadata
2020-11-24 15:15:51 +05:30
Each page can have additional, optional metadata (set in the
2020-07-28 23:09:34 +05:30
[default.html](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/fc3577921343173d589dfa43d837b4307e4e620f/layouts/default.html#L30-52)
2021-02-22 17:27:13 +05:30
Nanoc layout), which is displayed at the top of the page if defined:
2020-11-24 15:15:51 +05:30
2020-07-28 23:09:34 +05:30
- `reading_time`: If you want to add an indication of the approximate reading
time of a page, you can set `reading_time` to `true`. This uses a simple
[algorithm](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/master/lib/helpers/reading_time.rb)
to calculate the reading time based on the number of words.
2021-01-03 14:25:43 +05:30
## Move or rename a page
2021-02-22 17:27:13 +05:30
Moving or renaming a document is the same as changing its location.
Be sure to assign a technical writer to any MR that renames or moves a page. Technical
2021-01-03 14:25:43 +05:30
Writers can help with any questions and can review your change.
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
When moving or renaming a page, you must redirect browsers to the new page. This
ensures users find the new page, and have the opportunity to update their bookmarks.
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
There are two types of redirects:
2020-05-24 23:13:21 +05:30
2021-02-22 17:27:13 +05:30
- Redirect files added into the docs themselves, for users who view the docs in `/help`
on self-managed instances. For example, [`/help` on GitLab.com](https://gitlab.com/help).
- Redirects in a [`_redirects`](../../user/project/pages/redirects.md) file, for users
who view the docs on <http://docs.gitlab.com>.
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
To add a redirect:
2021-01-03 14:25:43 +05:30
2021-02-22 17:27:13 +05:30
1. In an MR in one of the internal docs projects (`gitlab`, `gitlab-runner`, `omnibus-gitlab`
or `charts`):
1. Move or rename the doc, but do not delete the old doc.
1. In the old doc, add the redirect code for `/help`. Use the following template exactly,
and only change the links and date. Use relative paths and `.md` for a redirect
to another docs page. Use the full URL to redirect to a different project or site:
2020-05-24 23:13:21 +05:30
2021-02-22 17:27:13 +05:30
```markdown
---
redirect_to: '../path/to/file/index.md'
---
2021-01-03 14:25:43 +05:30
2021-02-22 17:27:13 +05:30
This document was moved to [another location](../path/to/file/index.md).
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
<!-- This redirect file can be deleted after <YYYY-MM-DD>. -->
<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page -->
```
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
Redirect files linking to docs in any of the 4 internal docs projects can be
removed after 3 months. Redirect files linking to external sites can be removed
after 1 year.
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
1. If the document being moved has any Disqus comments on it, follow the steps
described in [Redirections for pages with Disqus comments](#redirections-for-pages-with-disqus-comments).
1. Assign the MR to a technical writer for review and merge.
1. If the redirect is to one of the 4 internal docs projects (not an external URL),
create an MR in [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs):
1. Update [`_redirects`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/master/content/_redirects)
with one redirect entry for each renamed or moved file. This code works for
<https://docs.gitlab.com> links only:
2020-05-24 23:13:21 +05:30
2021-02-22 17:27:13 +05:30
```plaintext
/ee/path/to/old_file.html /ee/path/to/new_file 302 # To be removed after YYYY-MM-DD
```
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
The path must start with the internal project directory `/ee` for `gitlab`,
`/gitlab-runner`, `/omnibus-gitlab` or `charts`, and must end with `.html`.
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
`_redirects` entries can be removed after one year.
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
1. Search for links to the old file. You must find and update all links to the old file:
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
- In <https://gitlab.com/gitlab-com/www-gitlab-com>, search for full URLs:
`grep -r "docs.gitlab.com/ee/path/to/file.html" .`
- In <https://gitlab.com/gitlab-org/gitlab-docs/-/tree/master/content/_data>,
search the navigation bar configuration files for the path with `.html`:
`grep -r "path/to/file.html" .`
- In any of the 4 internal projects. This includes searching for links in the docs
and codebase. Search for all variations, including full URL and just the path.
In macOS for example, go to the root directory of the `gitlab` project and run:
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
```shell
grep -r "docs.gitlab.com/ee/path/to/file.html" .
grep -r "path/to/file.html" .
grep -r "path/to/file.md" .
grep -r "path/to/file" .
```
You may need to try variations of relative links as well, such as `../path/to/file`
or even `../file` to find every case.
2018-11-08 19:23:39 +05:30
2019-07-31 22:56:46 +05:30
### Redirections for pages with Disqus comments
2018-11-08 19:23:39 +05:30
2019-12-04 20:38:33 +05:30
If the documentation page being relocated already has Disqus comments,
2018-11-08 19:23:39 +05:30
we need to preserve the Disqus thread.
2019-12-21 20:55:43 +05:30
Disqus uses an identifier per page, and for <https://docs.gitlab.com>, the page identifier
2018-11-08 19:23:39 +05:30
is configured to be the page URL. Therefore, when we change the document location,
we need to preserve the old URL as the same Disqus identifier.
2020-05-24 23:13:21 +05:30
To do that, add to the front matter the variable `disqus_identifier`,
using the old URL as value. For example, let's say we moved the document
2018-11-08 19:23:39 +05:30
available under `https://docs.gitlab.com/my-old-location/README.html` to a new location,
`https://docs.gitlab.com/my-new-location/index.html`.
2021-01-03 14:25:43 +05:30
Into the **new document** front matter, we add the following information. You must
2021-02-22 17:27:13 +05:30
include the filename in the `disqus_identifier` URL, even if it's `index.html` or `README.html`.
2018-11-08 19:23:39 +05:30
```yaml
---
2019-10-12 21:52:04 +05:30
disqus_identifier: 'https://docs.gitlab.com/my-old-location/README.html'
2018-11-08 19:23:39 +05:30
---
```
## Merge requests for GitLab documentation
Before getting started, make sure you read the introductory section
"[contributing to docs](#contributing-to-docs)" above and the
2019-02-15 15:39:39 +05:30
[documentation workflow](workflow.md).
2018-11-08 19:23:39 +05:30
2019-12-04 20:38:33 +05:30
- Use the current [merge request description template](https://gitlab.com/gitlab-org/gitlab/blob/master/.gitlab/merge_request_templates/Documentation.md)
2020-05-24 23:13:21 +05:30
- Label the MR `Documentation` (can only be done by people with `developer` access, for example, GitLab team members)
- Assign the correct milestone per note below (can only be done by people with `developer` access, for example, GitLab team members)
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
Documentation is merged if it is an improvement on existing content,
2019-02-15 15:39:39 +05:30
represents a good-faith effort to follow the template and style standards,
and is believed to be accurate.
Further needs for what would make the doc even better should be immediately addressed
2021-01-03 14:25:43 +05:30
in a follow-up merge request or issue.
2019-02-15 15:39:39 +05:30
2018-11-08 19:23:39 +05:30
If the release version you want to add the documentation to has already been
2020-05-24 23:13:21 +05:30
frozen or released, use the label `~"Pick into X.Y"` to get it merged into
2018-11-08 19:23:39 +05:30
the correct release. Avoid picking into a past release as much as you can, as
it increases the work of the release managers.
2019-02-15 15:39:39 +05:30
## GitLab `/help`
2019-09-30 21:07:59 +05:30
Every GitLab instance includes the documentation, which is available at `/help`
(`https://gitlab.example.com/help`). For example, <https://gitlab.com/help>.
2020-03-13 15:44:24 +05:30
The documentation available online on <https://docs.gitlab.com> is deployed every four hours from the `master` branch of GitLab, Omnibus, and Runner. Therefore,
2021-02-22 17:27:13 +05:30
after a merge request gets merged, it is available online on the same day.
However, it's shipped (and available on `/help`) within the milestone assigned
2019-02-15 15:39:39 +05:30
to the MR.
2020-03-13 15:44:24 +05:30
For example, let's say your merge request has a milestone set to 11.3, which
2021-02-22 17:27:13 +05:30
a release date of 2018-09-22. If it gets merged on 2018-09-15, it is
2019-02-15 15:39:39 +05:30
available online on 2018-09-15, but, as the feature freeze date has passed, if
2020-05-24 23:13:21 +05:30
the MR does not have a `~"Pick into 11.3"` label, the milestone has to be changed
2021-02-22 17:27:13 +05:30
to 11.4 and it ships with all GitLab packages only on 2018-10-22,
with GitLab 11.4. Meaning, it's available only with `/help` from GitLab
2020-03-13 15:44:24 +05:30
11.4 onward, but available on <https://docs.gitlab.com/> on the same day it was merged.
2019-02-15 15:39:39 +05:30
### Linking to `/help`
When you're building a new feature, you may need to link the documentation
from GitLab, the application. This is normally done in files inside the
`app/views/` directory with the help of the `help_page_path` helper method.
In its simplest form, the HAML code to generate a link to the `/help` page is:
```haml
= link_to 'Help page', help_page_path('user/permissions')
```
The `help_page_path` contains the path to the document you want to link to with
the following conventions:
- it is relative to the `doc/` directory in the GitLab repository
- the `.md` extension must be omitted
- it must not end with a slash (`/`)
Below are some special cases where should be used depending on the context.
You can combine one or more of the following:
1. **Linking to an anchor link.** Use `anchor` as part of the `help_page_path`
method:
2019-10-12 21:52:04 +05:30
```haml
= link_to 'Help page', help_page_path('user/permissions', anchor: 'anchor-link')
```
2019-02-15 15:39:39 +05:30
1. **Opening links in a new tab.** This should be the default behavior:
2019-10-12 21:52:04 +05:30
```haml
= link_to 'Help page', help_page_path('user/permissions'), target: '_blank'
```
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
1. **Using a question icon.** Usually used in settings where a long
2019-02-15 15:39:39 +05:30
description cannot be used, like near checkboxes. You can basically use
2020-11-24 15:15:51 +05:30
any GitLab SVG icon, but prefer the `question-o`:
2019-02-15 15:39:39 +05:30
2019-10-12 21:52:04 +05:30
```haml
2020-11-24 15:15:51 +05:30
= link_to sprite_icon('question-o'), help_page_path('user/permissions')
2019-10-12 21:52:04 +05:30
```
2019-02-15 15:39:39 +05:30
1. **Using a button link.** Useful in places where text would be out of context
with the rest of the page layout:
2019-10-12 21:52:04 +05:30
```haml
= link_to 'Help page', help_page_path('user/permissions'), class: 'btn btn-info'
```
2019-02-15 15:39:39 +05:30
1. **Using links inline of some text.**
2019-10-12 21:52:04 +05:30
```haml
Description to #{link_to 'Help page', help_page_path('user/permissions')}.
```
2019-02-15 15:39:39 +05:30
1. **Adding a period at the end of the sentence.** Useful when you don't want
the period to be part of the link:
2019-10-12 21:52:04 +05:30
```haml
= succeed '.' do
Learn more in the
= link_to 'Help page', help_page_path('user/permissions')
```
2019-02-15 15:39:39 +05:30
### GitLab `/help` tests
2020-05-24 23:13:21 +05:30
Several [RSpec tests](https://gitlab.com/gitlab-org/gitlab/blob/master/spec/features/help_pages_spec.rb)
2021-02-22 17:27:13 +05:30
are run to ensure GitLab documentation renders and works correctly. In particular, that [main docs landing page](../../README.md) works correctly from `/help`.
2019-02-15 15:39:39 +05:30
For example, [GitLab.com's `/help`](https://gitlab.com/help).
## Docs site architecture
See the [Docs site architecture](site_architecture/index.md) page to learn
2019-12-21 20:55:43 +05:30
how we build and deploy the site at <https://docs.gitlab.com> and
2019-02-15 15:39:39 +05:30
to review all the assets and libraries in use.
### Global navigation
See the [Global navigation](site_architecture/global_nav.md) doc for information
on how the left-side navigation menu is built and updated.
2019-01-03 12:48:30 +05:30
## Previewing the changes live
2021-02-22 17:27:13 +05:30
NOTE:
2019-01-03 12:48:30 +05:30
To preview your changes to documentation locally, follow this
2019-09-30 21:07:59 +05:30
[development guide](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/README.md#development-when-contributing-to-gitlab-documentation) or [these instructions for GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/gitlab_docs.md).
2019-01-03 12:48:30 +05:30
The live preview is currently enabled for the following projects:
2020-05-24 23:13:21 +05:30
- [`gitlab`](https://gitlab.com/gitlab-org/gitlab)
- [`gitlab-runner`](https://gitlab.com/gitlab-org/gitlab-runner)
2019-01-03 12:48:30 +05:30
2019-12-04 20:38:33 +05:30
If your merge request has docs changes, you can use the manual `review-docs-deploy` job
to deploy the docs review app for your merge request.
2021-02-22 17:27:13 +05:30
You need at least Maintainer permissions to be able to run it.
2019-01-03 12:48:30 +05:30
![Manual trigger a docs build](img/manual_build_docs.png)
2021-01-03 14:25:43 +05:30
You must push a branch to those repositories, as it doesn't work for forks.
2019-01-03 12:48:30 +05:30
2021-02-22 17:27:13 +05:30
The `review-docs-deploy*` job:
2019-01-03 12:48:30 +05:30
2021-02-22 17:27:13 +05:30
1. Creates a new branch in the [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs)
2019-12-21 20:55:43 +05:30
project named after the scheme: `docs-preview-$DOCS_GITLAB_REPO_SUFFIX-$CI_MERGE_REQUEST_IID`,
where `DOCS_GITLAB_REPO_SUFFIX` is the suffix for each product, e.g, `ee` for
EE, `omnibus` for Omnibus GitLab, etc, and `CI_MERGE_REQUEST_IID` is the ID
of the respective merge request.
2021-02-22 17:27:13 +05:30
1. Triggers a cross project pipeline and build the docs site with your changes.
2019-01-03 12:48:30 +05:30
2019-12-21 20:55:43 +05:30
In case the review app URL returns 404, this means that either the site is not
yet deployed, or something went wrong with the remote pipeline. Give it a few
minutes and it should appear online, otherwise you can check the status of the
remote pipeline from the link in the merge request's job output.
If the pipeline failed or got stuck, drop a line in the `#docs` chat channel.
2019-01-03 12:48:30 +05:30
Make sure that you always delete the branch of the merge request you were
2021-02-22 17:27:13 +05:30
working on. If you don't, the remote docs branch isn't removed either,
and the server where the Review Apps are hosted can eventually run out of
2019-01-03 12:48:30 +05:30
disk space.
2021-02-22 17:27:13 +05:30
NOTE:
2021-01-03 14:25:43 +05:30
Someone with no merge rights to the GitLab projects (think of forks from
contributors) cannot run the manual job. In that case, you can
ask someone from the GitLab team who has the permissions to do that for you.
2019-01-03 12:48:30 +05:30
### Troubleshooting review apps
In case the review app URL returns 404, follow these steps to debug:
1. **Did you follow the URL from the merge request widget?** If yes, then check if
the link is the same as the one in the job output.
1. **Did you follow the URL from the job output?** If yes, then it means that
either the site is not yet deployed or something went wrong with the remote
pipeline. Give it a few minutes and it should appear online, otherwise you
can check the status of the remote pipeline from the link in the job output.
If the pipeline failed or got stuck, drop a line in the `#docs` chat channel.
### Technical aspects
2019-02-15 15:39:39 +05:30
If you want to know the in-depth details, here's what's really happening:
2019-01-03 12:48:30 +05:30
2019-12-04 20:38:33 +05:30
1. You manually run the `review-docs-deploy` job in a merge request.
2020-10-24 23:57:45 +05:30
1. The job runs the [`scripts/trigger-build`](https://gitlab.com/gitlab-org/gitlab/blob/master/scripts/trigger-build)
script with the `docs deploy` flag, which in turn:
2019-01-03 12:48:30 +05:30
1. Takes your branch name and applies the following:
2019-12-21 20:55:43 +05:30
- The `docs-preview-` prefix is added.
- The product slug is used to know the project the review app originated
from.
- The number of the merge request is added so that you can know by the
`gitlab-docs` branch name the merge request it originated from.
2019-01-03 12:48:30 +05:30
1. The remote branch is then created if it doesn't exist (meaning you can
2021-02-22 17:27:13 +05:30
re-run the manual job as many times as you want and this step is skipped).
2019-01-03 12:48:30 +05:30
1. A new cross-project pipeline is triggered in the docs project.
1. The preview URL is shown both at the job output and in the merge request
widget. You also get the link to the remote pipeline.
1. In the docs project, the pipeline is created and it
2019-09-30 21:07:59 +05:30
[skips the test jobs](https://gitlab.com/gitlab-org/gitlab-docs/blob/8d5d5c750c602a835614b02f9db42ead1c4b2f5e/.gitlab-ci.yml#L50-55)
2019-01-03 12:48:30 +05:30
to lower the build time.
1. Once the docs site is built, the HTML files are uploaded as artifacts.
2020-11-24 15:15:51 +05:30
1. A specific runner tied only to the docs project, runs the Review App job
2019-01-03 12:48:30 +05:30
that downloads the artifacts and uses `rsync` to transfer the files over
to a location where NGINX serves them.
The following GitLab features are used among others:
2019-07-07 11:18:12 +05:30
- [Manual actions](../../ci/yaml/README.md#whenmanual)
2021-01-03 14:25:43 +05:30
- [Multi project pipelines](../../ci/multi_project_pipelines.md)
2019-01-03 12:48:30 +05:30
- [Review Apps](../../ci/review_apps/index.md)
- [Artifacts](../../ci/yaml/README.md#artifacts)
2020-11-24 15:15:51 +05:30
- [Specific runner](../../ci/runners/README.md#prevent-a-specific-runner-from-being-enabled-for-other-projects)
2019-12-21 20:55:43 +05:30
- [Pipelines for merge requests](../../ci/merge_request_pipelines/index.md)
2019-01-03 12:48:30 +05:30
2019-02-15 15:39:39 +05:30
## Testing
2018-11-08 19:23:39 +05:30
2021-01-29 00:20:46 +05:30
For more information on documentation testing, see [Documentation testing](testing.md)
2020-05-24 23:13:21 +05:30
2019-02-15 15:39:39 +05:30
## Danger Bot
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
GitLab uses [Danger](https://github.com/danger/danger) for some elements in
code review. For docs changes in merge requests, whenever a change to files under `/doc`
is made, Danger Bot leaves a comment with further instructions about the documentation
2020-05-24 23:13:21 +05:30
process. This is configured in the `Dangerfile` in the GitLab repository under
2019-12-04 20:38:33 +05:30
[/danger/documentation/](https://gitlab.com/gitlab-org/gitlab/tree/master/danger/documentation).
2020-11-24 15:15:51 +05:30
## Automatic screenshot generator
You can now set up an automatic screenshot generator to take and compress screenshots, with the
help of a configuration file known as **screenshot generator**.
### Use the tool
To run the tool on an existing screenshot generator, take the following steps:
1. Set up the [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/gitlab_docs.md).
1. Navigate to the subdirectory with your cloned GitLab repository, typically `gdk/gitlab`.
1. Make sure that your GDK database is fully migrated: `bin/rake db:migrate RAILS_ENV=development`.
2021-02-22 17:27:13 +05:30
1. Install pngquant, see the tool website for more information: [`pngquant`](https://pngquant.org/)
2020-11-24 15:15:51 +05:30
1. Run `scripts/docs_screenshots.rb spec/docs_screenshots/<name_of_screenshot_generator>.rb <milestone-version>`.
1. Identify the location of the screenshots, based on the `gitlab/doc` location defined by the `it` parameter in your script.
1. Commit the newly created screenshots.
### Extending the tool
To add an additional **screenshot generator**, take the following steps:
- Locate the `spec/docs_screenshots` directory.
- Add a new file with a `_docs.rb` extension.
- Be sure to include the following bits in the file:
```ruby
require 'spec_helper'
RSpec.describe '<What I am taking screenshots of>', :js do
include DocsScreenshotHelpers # Helper that enables the screenshots taking mechanism
before do
page.driver.browser.manage.window.resize_to(1366, 1024) # length and width of the page
end
```
- In addition, every `it` block must include the path where the screenshot is saved
```ruby
it 'user/packages/container_registry/img/project_image_repositories_list'
```
#### Full page screenshots
To take a full page screenshot simply `visit the page` and perform any expectation on real content (to have capybara wait till the page is ready and not take a white screenshot).
#### Element screenshot
To have the screenshot focuses few more steps are needed:
- **find the area**: `screenshot_area = find('#js-registry-policies')`
- **scroll the area in focus**: `scroll_to screenshot_area`
- **wait for the content**: `expect(screenshot_area).to have_content 'Expiration interval'`
- **set the crop area**: `set_crop_data(screenshot_area, 20)`
2021-02-22 17:27:13 +05:30
In particular, `set_crop_data` accepts as arguments: a `DOM` element and a
padding. The padding is added around the element, enlarging the screenshot area.
2020-11-24 15:15:51 +05:30
#### Live example
Please use `spec/docs_screenshots/container_registry_docs.rb` as a guide and as an example to create your own scripts.
2021-02-22 17:27:13 +05:30
<!-- This redirect file can be deleted after February 1, 2021. -->
<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page -->