Skip to content

Fix compilation of deprecations doc, and test it in CI

Marcel Amirault requested to merge docs-deprecations-ci-job into master

What does this MR do?

This improves the autogenerated deprecations doc:

  • The doc was not compiling when there were features added, so thanks to a suggestion from @godfat-gitlab, this is fixed.
  • Adds a new raketask that compiles a copy of the the doc, and verifies that it matches the current doc.
  • Adds a CI job to run the new raketask, which will ensure the doc never gets out of sync. It'll fail if you try to submit an MR without compiling the doc. The rules for the job ensure it only runs when these files are edited:
    • Feature YAML files
    • The deprecations doc
    • The deprecations doc .erb template
    • The files related to the rake task itself.
  • The doc was located in a new top-level directory (doc/deprecations), which we'd like to avoid (https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#folder-structure-overview). This moves the doc under doc/update, which is a related topic.
  • Copy edits the text.
  • Adjusts the spacing in the template to resolve linting errors when generating the doc with features listed:
Before After
Screen_Shot_2021-09-02_at_9.25.44 Screen_Shot_2021-09-02_at_9.26.43

Screenshots or Screencasts (strongly suggested)

How to setup and validate locally (strongly suggested)

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Marcel Amirault

Merge request reports