Documentation for instance level audit event streaming destinations
What does this MR do?
Documentation for newly introduced API and UI of instance level audit event streaming destinations.
Related issues
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
marked the checklist item I have evaluated the MR acceptance checklist for this MR. as completed
added docsimprovement documentation maintenancerefactor typemaintenance labels
assigned to @hraghuvanshi
1 Warning b5b398ab: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines. 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/administration/audit_event_streaming.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-
Setting label groupcompliance based on
@hraghuvanshi
's group.added groupcompliance label
- Resolved by Evan Read
@eread Can you please review this MR for the UI and API changes for supporting instance level external audit events streaming destinations, as we discussed in gitlab-com/www-gitlab-com!124301 (comment 1384064115).
/cc @nrosandich
requested review from @eread
added devopsgovern sectionsec labels
added docs-only label
- Resolved by Evan Read
- Resolved by Hitesh Raghuvanshi
- Resolved by Hitesh Raghuvanshi
- Resolved by Evan Read
- Resolved by Hitesh Raghuvanshi
- Resolved by Hitesh Raghuvanshi
- Resolved by Hitesh Raghuvanshi
- Resolved by Hitesh Raghuvanshi
- Resolved by Hitesh Raghuvanshi
- Resolved by Hitesh Raghuvanshi
- Resolved by Hitesh Raghuvanshi
- Resolved by Hitesh Raghuvanshi
- Resolved by Hitesh Raghuvanshi
changed milestone to %16.1
added Technical Writing docsfeature labels and removed docsimprovement label
removed review request for @eread
added 1 commit
- 83c49a01 - Added feature flags information as per suggestions
requested review from @eread
added 480 commits
-
a3ebe8b0...060ab9e2 - 469 commits from branch
master
- b5b398ab - 1 earlier commit
- e3b69cb1 - Create and list docs added
- eacc14ec - Update details added
- d9ed231a - Delete details added
- 533614cf - Verification token details added
- 33349740 - Added version history
- 42879746 - Fixed lint issue
- 97b1f1a3 - Fixed lint issue
- 38ab466e - Fixed lint issue
- 9dbbcdd4 - Added feature flags information as per suggestions
- 67903793 - Removed extra update
Toggle commit list-
a3ebe8b0...060ab9e2 - 469 commits from branch
mentioned in issue #413683 (closed)
mentioned in issue #413681 (closed)
enabled an automatic merge when the pipeline for 8cff7e00 succeeds
mentioned in commit 766a0f48
mentioned in merge request !123336 (merged)
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-production label and removed workflowproduction label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label