Clean up after docs MVC for jupyter_clean_diffs
What does this MR do?
The docs for !71477 (merged) had to merge in MVC status because I was about to leave on PTO, and I didn't want to hold up the engineering work. We created #344130 (closed) for the follow-up work on https://docs.gitlab.com/ee/user/project/repository/jupyter_notebooks/ including:
- rename image file to current standards, including a version number
- language cleanups in intro
- (most important) adding feature flag information, because the original MR strongly implies the existence of a feature flag
It's not a full cleanup of the page, but it gets us much closer to 'good.'
Related issues
- Closes #344130 (closed)
- Related to #345075 (closed)
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are only adding documentation, do not add any of the following labels:
~"type::feature"
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
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. - 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 above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.
Edited by Amy Qualls