Skip to content
Snippets Groups Projects

Update 6 readmes to index

Merged Marcel Amirault requested to merge docs-rename-readmes-ci-4 into master
All threads resolved!

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

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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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.
Edited by Marcel Amirault

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Achilleas Pipinellis
  • mentioned in issue #334679 (closed)

  • mentioned in commit 99927cf1

  • Marcel Amirault mentioned in merge request !64941 (closed)

    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).

  • Please register or sign in to reply
    Loading