Added link to click-through demo
What does this MR do?
Adds click-through demo and makes this a separate topic.
Related issues
Related to: technical-writing#978
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
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. -
Ensure a release milestone is set. - 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 reviews above. Maintainer's review can occur before or after a technical writer review.
Merge request reports
Activity
changed milestone to %16.9
added docsimprovement documentation maintenancerefactor typemaintenance labels
assigned to @sselhorn
added Technical Writing label
requested review from @jglassman1 and @dianalogan
1 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/user/project/repository/code_suggestions/index.md
(Link to current live version)
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.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger-
added docs-only label
- Resolved by Jon Glassman
@dianalogan @jglassman1 Here is an MR to add the click-through to the Code Suggestions page.
My concern with using the title of the video or click-through is that they're often not the most well-written--they tend to have typos or grammatical mistakes. For example, the video here has "setup" as one word instead of two. And when we have a video and a click-through like this, it just looks wordy. (See the Changes tab.)
In this case, I think I'd prefer to do something like:
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> [Watch a video overview](https://youtu.be/xQUlrbIWo8o). <!-- Video published on 2023-12-09 --> [View a click-through demo](https://gitlab.navattic.com/code-suggestions). <!-- Demo published on 2024-02-01 -->
Also, the click-through didn't have a date that I could see, so I just put today's date. Let me know if the date is available somewhere and I'm missing it.
Thanks.
removed review request for @dianalogan
@jglassman1, did you forget to run a pipeline before you merged this work? Based on our code review process, if the latest pipeline was created more than 4 hours ago, you should:
- Ensure the merge request is not in Draft status.
- Start a pipeline (especially important for Community contribution merge requests).
- Set the merge request to auto-merge.
This is a guideline, not a rule. Please consider replying to this comment for transparency.
This message was generated automatically. You're welcome to improve it.
mentioned in commit 3e78bf35
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-staging label and removed workflowproduction label