Skip to content

Update runner readmes to index

Marcel Amirault requested to merge docs-readme-to-index-runner into main

What does this MR do?

We are moving all README.md docs to index.md, and this is the MR for the runner files. This will help us to have clean URLs in the docs site without relying in symlink hacks like we do now.

index.md behaves the same as README.md in a repository, so no change in that case as well.

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.

Merge request reports

Loading