diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-07 00:09:33 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-07 00:09:33 +0000 |
commit | b56027c9d80ac0e297ba8a43c81e8504172dbf9f (patch) | |
tree | b85f743277145e930ae195664655d696e6e0a7fc /doc/development | |
parent | 7915c41e4261719719e791602c8235574157164c (diff) | |
download | gitlab-ce-b56027c9d80ac0e297ba8a43c81e8504172dbf9f.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development')
-rw-r--r-- | doc/development/auto_devops.md | 4 | ||||
-rw-r--r-- | doc/development/database_review.md | 4 | ||||
-rw-r--r-- | doc/development/documentation/structure.md | 12 |
3 files changed, 11 insertions, 9 deletions
diff --git a/doc/development/auto_devops.md b/doc/development/auto_devops.md index 656fb2ed1ad..dba68974dd5 100644 --- a/doc/development/auto_devops.md +++ b/doc/development/auto_devops.md @@ -18,12 +18,12 @@ which then defines jobs. Some jobs use images that are built from external projects: -- [Auto Build](../topics/autodevops/index.md#auto-build) uses +- [Auto Build](../topics/autodevops/stages.md#auto-build) uses [configuration](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Jobs/Build.gitlab-ci.yml) in which the `build` job uses an image that is built using the [`auto-build-image`](https://gitlab.com/gitlab-org/cluster-integration/auto-build-image) project. -- [Auto Deploy](../topics/autodevops/index.md#auto-deploy) uses +- [Auto Deploy](../topics/autodevops/stages.md#auto-deploy) uses [configuration](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Jobs/Deploy.gitlab-ci.yml) in which the jobs defined in this template use an image that is built using the [`auto-deploy-image`](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image) diff --git a/doc/development/database_review.md b/doc/development/database_review.md index d95fd7a38f6..f2db0ab4fd5 100644 --- a/doc/development/database_review.md +++ b/doc/development/database_review.md @@ -77,7 +77,9 @@ the following preparations into account. - Ensure `db/structure.sql` is updated. - Make migrations reversible by using the `change` method or include a `down` method when using `up`. - Include either a rollback procedure or describe how to rollback changes. -- Add the output of the migration(s) to the MR description. +- Add the output of both migrating and rolling back for all migrations into the MR description + - Ensure the down method reverts the changes in `db/structure.sql` + - Update the migration output whenever you modify the migrations during the review process - Add tests for the migration in `spec/migrations` if necessary. See [Testing Rails migrations at GitLab](testing_guide/testing_migrations_guide.md) for more details. - When [high-traffic](https://gitlab.com/gitlab-org/gitlab/-/blob/master/rubocop/migration_helpers.rb#L12) tables are involved in the migration, use the [`with_lock_retries`](migration_style_guide.md#retry-mechanism-when-acquiring-database-locks) helper method. Review the relevant [examples in our documentation](migration_style_guide.md#examples) for use cases and solutions. - Ensure RuboCop checks are not disabled unless there's a valid reason to. diff --git a/doc/development/documentation/structure.md b/doc/development/documentation/structure.md index e7a43f769b3..84ba47eba78 100644 --- a/doc/development/documentation/structure.md +++ b/doc/development/documentation/structure.md @@ -21,8 +21,10 @@ with exceptions and details noted below and in the template included on this pag - **Title**: Top-level heading with the feature name, or a use case name, which would start with a verb, like Configuring, Enabling, etc. -- **Introduction**: A couple sentences about the subject matter and what's to be found on this page. -- **Overview** Describe what it is, what it does, and in what context it should be used. +- **Introduction**: A couple sentences about the subject matter and what's to be found +on this page. Describe what the feature or topic is, what it does, and in what context it should +be used. There is no need to add a title called "Introduction" or "Overview," because people rarely + search for these terms. Just put this information after the title. - **Use cases**: describes real use case scenarios for that feature/configuration. - **Requirements**: describes what software, configuration, account, or knowledge is required. - **Instructions**: One or more sets of detailed instructions to follow. @@ -54,12 +56,10 @@ description: "Short document description." # Up to ~200 chars long. They will be > [Introduced](link_to_issue_or_mr) in GitLab (Tier) X.Y (2). An introduction -- without its own additional header -- goes here. -Offer a very short description of the feature or use case, and what to expect on this page. +Offer a description of the feature or use case, and what to expect on this page. (You can reuse this content, or part of it, for the front matter's `description` at the top of this file). -## Overview - -The feature overview should answer the following questions: +The introduction should answer the following questions: - What is this feature or use case? - Who is it for? |