Skip to content

Commit e5b5fb5

Browse files
author
GitLab Bot
committed
Add latest changes from gitlab-org/gitlab@master
1 parent 3b614c0 commit e5b5fb5

File tree

156 files changed

+1971
-411
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

156 files changed

+1971
-411
lines changed

.gitlab/ci/docs.gitlab-ci.yml

+23-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ review-docs-hugo-cleanup:
7676

7777
.docs-markdown-lint-image:
7878
# When updating the image version here, update it in /scripts/lint-doc.sh too.
79-
image: ${REGISTRY_HOST}/${REGISTRY_GROUP}/gitlab-docs/lint-markdown:alpine-3.20-vale-3.9.3-markdownlint2-0.17.1-lychee-0.18.0
79+
image: ${REGISTRY_HOST}/${REGISTRY_GROUP}/technical-writing/docs-gitlab-com/lint-markdown:alpine-3.21-vale-3.9.3-markdownlint2-0.17.1-lychee-0.18.0
8080

8181
docs-lint markdown:
8282
extends:
@@ -111,6 +111,28 @@ docs code_quality:
111111
expire_in: 2 weeks
112112
when: always
113113

114+
docs hugo_build:
115+
image: hugomods/hugo:exts-0.142.0
116+
extends:
117+
- .default-retry
118+
- .docs:rules:docs-lint
119+
stage: lint
120+
needs: []
121+
dependencies: []
122+
before_script:
123+
- apk add --no-cache git make nodejs npm bash
124+
- git clone --depth 1 --filter=tree:0 https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com.git
125+
- cd docs-gitlab-com
126+
- make add-latest-icons
127+
# Copy the current project's docs to the appropriate location in the docs website
128+
- cp -r ../doc/* content/
129+
script:
130+
# Test that Hugo will build
131+
- hugo --gc --printPathWarnings --panicOnWarning
132+
# Test for invalid index pages
133+
# See https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/blob/main/scripts/check-index-filenames.sh
134+
- make check-index-pages SEARCH_DIR="../doc"
135+
114136
docs-lint links:
115137
extends:
116138
- .docs:rules:docs-lint

.gitlab/issue_templates/AI Project Proposal.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ TITLE FORMAT
1010
The title should be something that is easily understood that quickly communicates the intent of the project allowing team members to easily understand and recognize the expected work that will be done. A proposal title should combine the beneficiary of the feature/UI, the job it will allow them to accomplish (see https://about.gitlab.com/handbook/product/ux/jobs-to-be-done/#how-to-write-a-jtbd), and their expected outcome when the work is delivered. Well-defined statements are concise without sacrificing the substance of the proposal so that anyone can understand it at a glance. (e.g. {Reduce the effort} {for security teams} {when prioritizing business-critical risks in their assets}).
1111
-->
1212

13-
# [Experiment](https://docs.gitlab.com/ee/policy/alpha-beta-support.html#experiment)
13+
# [Experiment](https://docs.gitlab.com/policy/development_stages_support/#experiment)
1414
_This section should be completed prior to beginning work on the Experiment._
1515

1616
## Problem to be solved
@@ -38,9 +38,9 @@ _How will you measure whether this experiment is a success?_
3838
| [Problem validation](https://about.gitlab.com/handbook/product/ai/ux-maturity/#validation-problem-validation)<br>How well do we understand the problem? | [Mix of evidence and assumptions](https://about.gitlab.com/handbook/product/ai/ux-maturity/#questions-to-ask) | <!-- Acceptable answers: Yes, Somewhat or Somewhat, Somewhat --> |
3939
| [Solution validation](https://about.gitlab.com/handbook/product/ai/ux-maturity/#validation-solution-validation)<br>How usable is the solution? | [Usability testing](https://about.gitlab.com/handbook/product/ux/ux-scorecards/#option-b-perform-a-formative-evaluation), Grade C | <!-- Acceptable: >80% and grade C --> |
4040
| [Improve](https://about.gitlab.com/handbook/product/ai/ux-maturity/#build-improve)<br>How successful is the solution? | Quality goals set by the team are reached. | <!-- Acceptable answers: :white_check_mark: Reached all quality goals for this phase. --> |
41-
| [Design standards](https://about.gitlab.com/handbook/product/ai/ux-maturity/#design-standards) adherence<br>How compliant is the solution with our design standards? | Should adhere to ([Pajamas](https://design.gitlab.com/), [checklist](https://docs.gitlab.com/ee/development/contributing/design.html#checklist)) | <!-- Acceptable: Mostly adheres to design standards --> |
41+
| [Design standards](https://about.gitlab.com/handbook/product/ai/ux-maturity/#design-standards) adherence<br>How compliant is the solution with our design standards? | Should adhere to ([Pajamas](https://design.gitlab.com/), [checklist](https://docs.gitlab.com/development/contributing/design/#checklist)) | <!-- Acceptable: Mostly adheres to design standards --> |
4242

43-
# [Beta](https://docs.gitlab.com/ee/policy/alpha-beta-support.html#beta)
43+
# [Beta](https://docs.gitlab.com/policy/development_stages_support/#beta)
4444
_This section should be completed prior to beginning work on the Beta experience._
4545
<!-- DO NOT REMOVE THIS SECTION
4646
Although the initial focus is on the “Experiment” section, do not remove this “Beta” section. It's important that we link Experiment to Beta release. Fill this section in as you progress.
@@ -86,9 +86,9 @@ _How will you measure whether this Beta is a success?_
8686
| [Problem validation](https://about.gitlab.com/handbook/product/ai/ux-maturity/#validation-problem-validation)<br>How well do we understand the problem? | [Mix of evidence and assumptions](https://about.gitlab.com/handbook/product/ai/ux-maturity/#questions-to-ask) | <!-- Acceptable answers: Yes, Yes --> |
8787
| [Solution validation](https://about.gitlab.com/handbook/product/ai/ux-maturity/#validation-solution-validation)<br>How usable is the solution? | [Usability testing](https://about.gitlab.com/handbook/product/ux/ux-scorecards/#option-b-perform-a-formative-evaluation) and [Heuristic evaluation](https://about.gitlab.com/handbook/product/ux/ux-scorecards/#option-a-conduct-a-heuristic-evaluation), Avg. task pass rate >80%, Grade B | <!-- Acceptable: >80% and grade B --> |
8888
| [Improve](https://about.gitlab.com/handbook/product/ai/ux-maturity/#build-improve)<br>How successful is the solution? | Quality goals set by the team are reached. | <!-- Acceptable answers: :white_check_mark: Reached all quality goals for this phase. --> |
89-
| [Design standards](https://about.gitlab.com/handbook/product/ai/ux-maturity/#design-standards) adherence<br>How compliant is the solution with our design standards? | Should adhere to ([Pajamas](https://design.gitlab.com/), [checklist](https://docs.gitlab.com/ee/development/contributing/design.html#checklist)) | <!-- Acceptable: Completely adheres to design standards --> |
89+
| [Design standards](https://about.gitlab.com/handbook/product/ai/ux-maturity/#design-standards) adherence<br>How compliant is the solution with our design standards? | Should adhere to ([Pajamas](https://design.gitlab.com/), [checklist](https://docs.gitlab.com/development/contributing/design/#checklist)) | <!-- Acceptable: Completely adheres to design standards --> |
9090

91-
# [Generally Available](https://docs.gitlab.com/ee/policy/alpha-beta-support.html#generally-available-ga)
91+
# [Generally Available](https://docs.gitlab.com/policy/development_stages_support/#generally-available)
9292
<!-- DO NOT REMOVE THIS SECTION
9393
Although the initial focus is on the “Experiment” section, do not remove this “Generally Available” section. It's important that we link Beta to GA release. Fill this section in as you progress.
9494
-->
@@ -150,7 +150,7 @@ _What tasks or actions should the user be capable of performing with this featur
150150
- [ ] Add all related feature issues to the Linked items section
151151
- [ ] Add all relevant solution validation issues to the Linked items section that shows this proposal will solve the customer problem, or details explaining why it's not possible to provide that validation.
152152
- [ ] Add relevant designs to the Design Management area of the issue.
153-
- [ ] You have adhered to our [Definition of Done](https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html#definition-of-done) standards
153+
- [ ] You have adhered to our [Definition of Done](https://docs.gitlab.com/development/contributing/merge_request_workflow/#definition-of-done) standards
154154
- [ ] Completed the necessary steps to move from Beta to GA
155155

156156
</details>
@@ -167,15 +167,15 @@ _What tasks or actions should the user be capable of performing with this featur
167167
- [ ] Requirements have been defined
168168
- [ ] Add all relevant solution validation issues to the Linked items section that shows this proposal will solve the customer problem, or details explaining why it's not possible to provide that validation.
169169
- [ ] Add relevant designs to the Design Management area of the issue.
170-
- [ ] You have adhered to our [Definition of Done](https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html#definition-of-done) standards
170+
- [ ] You have adhered to our [Definition of Done](https://docs.gitlab.com/development/contributing/merge_request_workflow/#definition-of-done) standards
171171
- [ ] Ensure this issue has the ~wg-ai-integration label to ensure visibility to various teams working on this
172172

173173
</details>
174174

175175
<details> <summary> Technical needs </summary>
176176

177177
- [ ] Please consider the operational aspects of the feature you are creating. A list of things to think about is in: https://gitlab.com/gitlab-org/gitlab/-/issues/403859. We will be improving this process in the future: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117637#note_1353253349.
178-
- [ ] @ mention your [AppSec Stable Counterpart](https://about.gitlab.com/handbook/product/categories/) and read the [AI secure coding guidelines](https://docs.gitlab.com/ee/development/secure_coding_guidelines.html#artificial-intelligence-ai-features)
178+
- [ ] @ mention your [AppSec Stable Counterpart](https://about.gitlab.com/handbook/product/categories/) and read the [AI secure coding guidelines](https://docs.gitlab.com/development/secure_coding_guidelines/#artificial-intelligence-ai-features)
179179

180180
1. Work estimate and skills needs to build an ML viable feature: To build any ML feature depending on the work, there are many personas that contribute including Data Scientist, NLP engineer, ML Engineer, MLOps Engineer, ML Infra engineers, Fullstack engineer to integrate the ML Services with Gitlab. Post-prototype we would assess the skills needed to build a production-grade ML feature for the prototype.
181181
2. Data Limitation: We would like to upfront validate if we have viable data for the feature including whether we can use the DataOps pipeline of ModelOps or create a custom one. We would want to understand the training data, test data, and feedback data to dial up the accuracy and the limitations of the data.

.gitlab/issue_templates/Audit Event Proposal.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<!-- Audit event documentation: See https://docs.gitlab.com/ee/administration/audit_events.html -->
2-
<!-- Streaming audit event documentation: See https://docs.gitlab.com/ee/administration/audit_event_streaming.html -->
1+
<!-- Audit event documentation: See https://docs.gitlab.com/administration/audit_events/ -->
2+
<!-- Streaming audit event documentation: See https://docs.gitlab.com/administration/audit_event_streaming/ -->
33

44
## Audit need
55

.gitlab/issue_templates/Broken Master - Flaky.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Please read the below documentations for a workflow of triaging and resolving br
1616

1717
<!-- If the pipeline failure is reproducible, provide steps to recreate the issue locally. Please use an ordered list. -->
1818

19-
Please refer to [Flaky tests documentation](https://docs.gitlab.com/ee/development/testing_guide/flaky_tests.html) to
19+
Please refer to [Flaky tests documentation](https://docs.gitlab.com/development/testing_guide/flaky_tests/) to
2020
learn more about how to reproduce them.
2121

2222
### Proposed Resolution

.gitlab/issue_templates/Deprecations.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -149,10 +149,10 @@ External Communication Plan
149149
- [ ] Ensure you have approvals from legal and corp comms for any communication being sent directly to customers.
150150
- [ ] As soon as possible, but no later than the third milestone preceding the major release, ensure that the following are complete (for example, given the following release schedule: `17.8, 17.9, 17.10, 17.11, 18.0``17.9` is the third milestone preceding the major release).
151151
- [ ] A [deprecation announcement entry](https://about.gitlab.com/handbook/marketing/blog/release-posts/#creating-the-announcement) has been created so the deprecation will appear in release posts and on the [general deprecation page](https://docs.gitlab.com/ee/update/deprecations). _Add link to the relevant merge request._
152-
- [ ] Documentation has been updated to mark the feature as [deprecated](https://docs.gitlab.com/ee/development/documentation/versions.html#deprecations-and-removals). _Add link to the relevant merge request._
152+
- [ ] Documentation has been updated to mark the feature as [deprecated](https://docs.gitlab.com/development/documentation/versions/#deprecations-and-removals). _Add link to the relevant merge request._
153153
- [ ] On the major milestone:
154154
- [ ] The deprecated item has been removed. _Add link to the relevant merge request._
155-
- [ ] If the removal of the deprecated item is a [breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change), the merge request is labeled ~"breaking change".
155+
- [ ] If the removal of the deprecated item is a [breaking change](https://docs.gitlab.com/update/terminology/#breaking-change), the merge request is labeled ~"breaking change".
156156
- [ ] Document the migration plan for users, clearly outlining the actions they need to take to mitigate the impact of the breaking change.
157157
- [ ] [Add link](here)
158158

@@ -209,7 +209,7 @@ Keep in mind that approval check boxes and deprecations notices alone are not su
209209
/label ~"awaiting-pm-approval" ~"awaiting-em-approval" ~"awaiting-senior-eng-approval" ~"awaiting-senior-product-approval"
210210

211211
- [ ] This issue is labeled ~deprecation, and with the relevant `~devops::`, `~group::`, and `~Category:` labels.
212-
- [ ] This issue is labeled ~"breaking change" if the removal of the deprecated item will be a [breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change).
212+
- [ ] This issue is labeled ~"breaking change" if the removal of the deprecated item will be a [breaking change](https://docs.gitlab.com/update/terminology/#breaking-change).
213213

214214

215215
<!-- Label reminders - you should have one of each of the following labels.
@@ -226,9 +226,9 @@ Use the following resources to find the appropriate labels:
226226
- [Deprecations, removals, and breaking changes](https://handbook.gitlab.com/handbook/marketing/blog/release-posts/#deprecations-removals-and-breaking-changes)
227227
- [Deprecation guidelines](https://docs.gitlab.com/ee/development/deprecation_guidelines/)
228228
- [Deprecations and removals doc styleguide](https://docs.gitlab.com/ee/development/documentation/styleguide/deprecations_and_removals)
229-
- [REST API Deprecations](https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#deprecations) and [REST API breaking changes](https://docs.gitlab.com/ee/development/api_styleguide.html#breaking-changes).
230-
- [GraphQL Deprecations](https://docs.gitlab.com/ee/development/api_graphql_styleguide.html#deprecating-schema-items) and [GraphQL API breaking changes](https://docs.gitlab.com/ee/development/api_graphql_styleguide.html#breaking-changes).
231-
- [GitLab release and maintenance policy](https://docs.gitlab.com/ee/policy/maintenance.html)
229+
- [REST API Deprecations](https://docs.gitlab.com/development/documentation/restful_api_styleguide/#deprecations) and [REST API breaking changes](https://docs.gitlab.com/development/api_styleguide/#breaking-changes).
230+
- [GraphQL Deprecations](https://docs.gitlab.com/development/api_graphql_styleguide/#deprecating-schema-items) and [GraphQL API breaking changes](https://docs.gitlab.com/development/api_graphql_styleguide/#breaking-changes).
231+
- [GitLab release and maintenance policy](https://docs.gitlab.com/policy/maintenance/)
232232
- Videos 📺
233233
- [How to deprecate and remove features in GitLab releases](https://youtu.be/9gy7tg94j7s)
234234
- [Review of GitLab deprecations and removals policy & Runner team deprecations and removals process](https://youtu.be/ehT1xBajCRI)

.gitlab/issue_templates/Doc_cleanup.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
* Use this template for documentation issues identified
3-
* by [Vale](https://docs.gitlab.com/ee/development/documentation/testing/vale.html)
4-
* or [markdownlint](https://docs.gitlab.com/ee/development/documentation/testing/markdownlint.html).
3+
* by [Vale](https://docs.gitlab.com/development/documentation/testing/vale/)
4+
* or [markdownlint](https://docs.gitlab.com/development/documentation/testing/markdownlint/).
55
* This template is meant to describe work for first-time contributors or
66
* for work during Hackathons.
77
*
@@ -20,14 +20,14 @@ Do you want to work on this issue?
2020

2121
## To resolve the issue
2222

23-
[Follow these instructions to create a merge request](https://docs.gitlab.com/ee/development/documentation/workflow.html#how-to-update-the-docs).
23+
[Follow these instructions to create a merge request](https://docs.gitlab.com/development/documentation/workflow/#how-to-update-the-docs).
2424

2525
- Don't submit your merge request until after the Hackathon has started.
2626
- Try to address the issue in a single merge request.
2727
- Try to stick to the scope of the issue. If you see other improvements that can be made in the file, open a separate merge request.
2828
- When you create the merge request, select the **Documentation** merge request description template.
2929
- In the merge request's description, add a link to this issue.
30-
- Follow the [commit message guidelines](https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html#commit-messages-guidelines).
30+
- Follow the [commit message guidelines](https://docs.gitlab.com/development/contributing/merge_request_workflow/#commit-messages-guidelines).
3131
Use three to five words for your commit message, start with message with a capital letter, and do **not** end it in a period.
3232
Other commit messages can cause the pipeline to fail.
3333

0 commit comments

Comments
 (0)