Rename protected-branch subheadings to prevent confusion

changed milestone to %16.1

added Category:Source Code Management Technical Writing devopscreate docsimprovement documentation groupsource code maintenancerefactor sectiondev tw-weight3 typemaintenance labels

assigned to @aqualls

mentioned in issue #389054 (closed)

	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/api/protected_branches.md (Link to current live version)
doc/ci/pipelines/schedules.md (Link to current live version)
doc/user/project/deploy_keys/index.md (Link to current live version)
doc/user/project/import/github.md (Link to current live version)
doc/user/project/protected_branches.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.

Reviewer roulette

Changes that require review have been detected!

Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:

Category	Reviewer	Maintainer
backend	Eduardo Bonet (`@eduardobonet`) (UTC+2, 9 hours ahead of `@aqualls`)	Ahmed Hemdan (`@ahmed.hemdan`) (UTC+2, 9 hours ahead of `@aqualls`)
frontend	Ross Byrne (`@robyrne`) (UTC+1, 8 hours ahead of `@aqualls`)	Frédéric Caplette (`@f_caplette`) (UTC-4, 3 hours ahead of `@aqualls`)

To spread load more evenly across eligible reviewers, Danger has picked a candidate for each review slot, based on their timezone. Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.

To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.

Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

added 1 commit

d0f4ba65 - Update link to changed branch name

Compare with previous version

added backend frontend labels

@sean_carroll I'm sending this over for you to review - I've spun up a review app so you can see the changes. Do these renamings help? If yes, I'll get it over to a FE and technical writer for review / merge.

requested review from @sean_carroll

Allure report

allure-report-publisher generated test report!

e2e-test-on-gdk: test report for 395ad3d1

expand test summary

+-----------------------------------------------------------------------+
|                            suites summary                             |
+------------------+--------+--------+---------+-------+-------+--------+
|                  | passed | failed | skipped | flaky | total | result |
+------------------+--------+--------+---------+-------+-------+--------+
| Create           | 8      | 0      | 1       | 0     | 9     | ✅     |
| Manage           | 1      | 0      | 0       | 0     | 1     | ✅     |
| Plan             | 4      | 0      | 0       | 0     | 4     | ✅     |
| Framework sanity | 0      | 0      | 1       | 0     | 1     | ➖     |
| Govern           | 2      | 0      | 0       | 0     | 2     | ✅     |
| Monitor          | 4      | 0      | 0       | 0     | 4     | ✅     |
| Data Stores      | 2      | 0      | 0       | 1     | 2     | ❗     |
+------------------+--------+--------+---------+-------+-------+--------+
| Total            | 21     | 0      | 2       | 1     | 23    | ❗     |
+------------------+--------+--------+---------+-------+-------+--------+

e2e-review-qa: test report for 395ad3d1

expand test summary

+-----------------------------------------------------------------------+
|                            suites summary                             |
+------------------+--------+--------+---------+-------+-------+--------+
|                  | passed | failed | skipped | flaky | total | result |
+------------------+--------+--------+---------+-------+-------+--------+
| Create           | 27     | 0      | 1       | 1     | 28    | ❗     |
| Plan             | 3      | 0      | 1       | 3     | 4     | ❗     |
| Framework sanity | 0      | 0      | 1       | 0     | 1     | ➖     |
| Govern           | 2      | 0      | 0       | 2     | 2     | ❗     |
| Monitor          | 4      | 0      | 0       | 2     | 4     | ❗     |
| Manage           | 1      | 0      | 0       | 0     | 1     | ✅     |
| Data Stores      | 2      | 0      | 0       | 2     | 2     | ❗     |
+------------------+--------+--------+---------+-------+-------+--------+
| Total            | 39     | 0      | 3       | 10    | 42    | ❗     |
+------------------+--------+--------+---------+-------+-------+--------+

resolved all threads

approved this merge request

@sean_carroll, thanks for approving this merge request.

This is the first time the merge request is approved. To ensure full test coverage, a new pipeline will be started shortly.

For more info, please refer to the following links:

added pipeline:mr-approved label

Looks good to me @aqualls

I don't think it needs backend review, but could you please review the frontend change @jerasmus ?

requested review from @jerasmus

removed backend label

added backend label

Unassigning Sean, as he's approved. Assigning @msedlakjakubowski, especially since he's in a similar time zone to Jacques. (ONE DAY and I already am grateful for the extra TW.)

Docs changes:

Rename subheading Configure a protected branch to Add protection to existing branches
Rename subheading Configure multiple protected branches by using a wildcard to Protect multiple branches with wildcard rules
Rename subheading Create a protected branch to Create a new branch with protections
Update crosslinks to changed subheading, including one in the UI which is why we have the long pipeline.

requested review from @msedlakjakubowski and removed review request for @sean_carroll

@aqualls thanks for making these changes! It looks like we just have one or two places to update the anchor on the frontend then we should be good to go. Here's a patch for you:

diff --git a/app/assets/javascripts/projects/settings/branch_rules/components/edit/branch_dropdown.vue b/app/assets/javascripts/projects/settings/branch_rules/components/edit/branch_dropdown.vue
index 3dcacf9eb349..6494456d5600 100644
--- a/app/assets/javascripts/projects/settings/branch_rules/components/edit/branch_dropdown.vue
+++ b/app/assets/javascripts/projects/settings/branch_rules/components/edit/branch_dropdown.vue
@@ -55,7 +55,7 @@ export default {
   },
   searchInputDelay: 250,
   wildcardsHelpPath: helpPagePath('user/project/protected_branches', {
-    anchor: 'configure-multiple-protected-branches-by-using-a-wildcard',
+    anchor: 'protect-multiple-branches-with-wildcard-rules',
   }),
   props: {
     projectPath: {
diff --git a/app/assets/javascripts/projects/settings/branch_rules/components/view/constants.js b/app/assets/javascripts/projects/settings/branch_rules/components/view/constants.js
index b71c33d2b91d..a45ed5c68afe 100644
--- a/app/assets/javascripts/projects/settings/branch_rules/components/view/constants.js
+++ b/app/assets/javascripts/projects/settings/branch_rules/components/view/constants.js
@@ -49,7 +49,7 @@ export const BRANCH_PARAM_NAME = 'branch';
 export const ALL_BRANCHES_WILDCARD = '*';
 
 export const WILDCARDS_HELP_PATH =
-  'user/project/protected_branches#configure-multiple-protected-branches-by-using-a-wildcard';
+  'user/project/protected_branches#protect-multiple-branches-with-wildcard-rules';
 
 export const PROTECTED_BRANCHES_HELP_PATH = 'user/project/protected_branches';

Back to you for now

removed review request for @jerasmus

approved this merge request

added UI text workflowin dev labels

removed review request for @msedlakjakubowski

added 1 commit

395ad3d1 - Fix more UI links

Compare with previous version

approved this merge request

requested review from @jerasmus

resolved all threads

enabled an automatic merge when the pipeline for 2b88009a succeeds

Bundle size analysis [beta]

This compares changes in bundle size for entry points between the commits e7232025 and 395ad3d1

Special assets

Entrypoint / Name	Size before	Size after	Diff	Diff in percent
mainChunk	2.95 MB	2.95 MB	-	0.0 %
average	4.09 MB	4.09 MB	-	0.0 %

Note: We do not have exact data for e7232025. So we have used data from: 4762114e.
The target commit was too new, so we used the latest commit from master we have info on.
It might help to rerun the bundle-size-review job
This might mean that you have a few false positives in this report. If something unrelated to your code changes is reported, you can check this comparison in order to see if they caused this change.

Please look at the full report for more details

Rename protected-branch subheadings to prevent confusion

What does this MR do?

Related issues

Author's checklist

Reviewer's checklist

Merged by Jacques Erasmus 1 year ago (May 25, 2023 5:53pm UTC) 1 year ago

Activity

Documentation review

Reviewer roulette

Allure report

Bundle size analysis [beta]

Special assets

Rename protected-branch subheadings to prevent confusion

What does this MR do?

Related issues

Author's checklist

Reviewer's checklist

Merge request reports

Merged by Jacques Erasmus 1 year ago (May 25, 2023 5:53pm UTC) 1 year ago

Activity

Documentation review

Reviewer roulette

Allure report

Bundle size analysis [beta]

Special assets