Update 6 readmes to index
What does this MR do?
Rename more README.md
files in doc/
to index.md
, as part of the related issue.
Updates:
doc/security/README.md
doc/README.md
doc/ssh/README.md
doc/development/README.md
doc/migrate_ci_to_ce/README.md
doc/administration/auth/README.md
Related issues
Related to gitlab-docs#864 (closed)
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
Ensure that the product tier badge is added to doc's h1
. -
Request a review based on the documentation page's metadata and associated Technical Writer.
To avoid having this MR be added to code verification QA issues, don't add these labels: feature, frontend, backend, ~"bug", or database
Review 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 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. - 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 of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list.
-
-
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.
Merge request reports
Activity
changed milestone to %14.1
added Technical Writing docsnon-content documentation twdoing labels
assigned to @marcel.amirault
1 Warning This merge request is quite big (1889 lines changed), please consider splitting it into multiple merge requests. 2 Messages CHANGELOG missing: If you want to create a changelog entry for GitLab FOSS, add the
Changelog
trailer to the commit message you want to add to the changelog.If you want to create a changelog entry for GitLab EE, also add the
EE: true
trailer to your commit message.If this merge request doesn't need a CHANGELOG entry, feel free to ignore this message.
This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
doc/README.md
doc/administration/auth/index.md
doc/administration/compliance.md
doc/administration/configure.md
doc/administration/geo/replication/usage.md
doc/administration/index.md
doc/administration/troubleshooting/postgresql.md
doc/ci/examples/laravel_with_gitlab_and_envoy/index.md
doc/ci/review_apps/index.md
doc/ci/ssh_keys/index.md
doc/development/README.md
doc/development/changelog.md
doc/development/code_review.md
doc/development/contributing/merge_request_workflow.md
doc/development/dangerbot.md
doc/development/documentation/index.md
doc/development/documentation/structure.md
doc/development/documentation/styleguide/index.md
doc/development/emails.md
doc/development/gitaly.md
doc/development/go_guide/index.md
doc/development/index.md
doc/development/pipelines.md
doc/development/shell_scripting_guide/index.md
doc/development/testing_guide/index.md
doc/gitlab-basics/create-your-ssh-keys.md
doc/gitlab-basics/index.md
doc/gitlab-basics/start-using-git.md
doc/index.md
doc/install/azure/index.md
doc/install/next_steps.md
doc/migrate_ci_to_ce/index.md
doc/security/README.md
doc/security/index.md
doc/security/passwords_for_integrated_authentication_methods.md
doc/ssh/README.md
doc/ssh/index.md
doc/topics/authentication/index.md
doc/topics/git/how_to_install_git/index.md
doc/topics/git/troubleshooting_git.md
doc/topics/set_up_organization.md
doc/user/admin_area/settings/sign_in_restrictions.md
doc/user/group/saml_sso/index.md
doc/user/group/settings/import_export.md
doc/user/markdown.md
doc/user/profile/index.md
doc/user/project/settings/import_export.md
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
Reviewer roulette
Changes that require review have been detected!
Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:
Category Reviewer Maintainer backend Alex Buijs ( @alexbuijs
) (UTC+2, 7 hours behind@marcel.amirault
)Douglas Barbosa Alexandre ( @dbalexandre
) (UTC-3, 12 hours behind@marcel.amirault
)frontend Tristan Read ( @tristan.read
) (UTC+12, 3 hours ahead of@marcel.amirault
)Andrew Fontaine ( @afontaine
) (UTC-4, 13 hours behind@marcel.amirault
)To spread load more evenly across eligible reviewers, Danger has picked a candidate for each review slot, based on their timezone. Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.
To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.
Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Dangerrequested review from @ekigbo
- Resolved by Marcel Amirault
@ekigbo Are the link changes to the frontend files OK? If they look fine, could you give the
, but don't merge. The TW team plans to merge later, at the same time as a change in the docs project to match.
Allure report
allure-report-publisher
generated test report for 4d973bdc!review-qa-smoke:
test reportmentioned in issue gitlab-docs#864 (closed)
removed review request for @ekigbo
mentioned in merge request gitlab-docs!1923 (merged)
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
mentioned in issue #334679 (closed)
mentioned in commit 99927cf1
added workflowstaging label
mentioned in merge request !64941 (closed)
added workflowcanary label and removed workflowstaging label
added workflowproduction label and removed workflowcanary label
Hey @marcel.amirault @ekigbo @axil, just a note that I discovered we also needed to update: !65624 (merged).
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label
added typemaintenance label