Fix invalid example for database dictionary yml file
What does this MR do?
The example for a database dictionary file in the official documentation is errorneous, see https://docs.gitlab.com/ee/development/database/database_dictionary.html#example-dictionary-file . When using this example and running rails db:migrate
it will lead to the following unexpected and irritating error. After a few moments, you realize that yaml file should have only three dash characters (---
) and not four ----
;-). This MR fixes the example to avoid confusion in the future.
StandardError: An error has occurred, this and all later migrations canceled:
(<unknown>): mapping values are not allowed in this context at line 2 column 11
/Users/client-siemens/Development/gitlab-development-kit/gitlab/lib/gitlab/database/gitlab_schema.rb:129:in `block in build_dictionary'
/Users/client-siemens/Development/gitlab-development-kit/gitlab/lib/gitlab/database/gitlab_schema.rb:128:in `each'
/Users/client-siemens/Development/gitlab-development-kit/gitlab/lib/gitlab/database/gitlab_schema.rb:128:in `each_with_object'
...
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on:- The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead ofDefault behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead ofConfiguring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.