From 0c872e02b2c822e3397515ec324051ff540f0cd5 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Tue, 20 Dec 2022 14:22:11 +0000 Subject: Add latest changes from gitlab-org/gitlab@15-7-stable-ee --- .gitlab/issue_templates/Broken Master - Flaky.md | 5 +- .../issue_templates/Broken Master - Non-flaky.md | 2 +- .gitlab/issue_templates/Doc_cleanup.md | 80 +++++++--------------- .gitlab/issue_templates/Feature Flag Roll Out.md | 18 +++-- .../Geo Replicate a new Git repository type.md | 45 +++++++++--- .../Geo Replicate a new blob type.md | 36 +++++++--- .gitlab/issue_templates/Global Search - bug.md | 30 ++++++++ .gitlab/issue_templates/Global Search - feature.md | 13 ++++ .../issue_templates/Global Search - maintenance.md | 11 +++ .../Navigation - Left Sidebar Proposals.md | 14 ---- .gitlab/issue_templates/Navigation Proposals.md | 15 ++++ .../issue_templates/Security developer workflow.md | 4 +- .gitlab/issue_templates/UX Theme.md | 51 ++++++++++---- 13 files changed, 211 insertions(+), 113 deletions(-) create mode 100644 .gitlab/issue_templates/Global Search - bug.md create mode 100644 .gitlab/issue_templates/Global Search - feature.md create mode 100644 .gitlab/issue_templates/Global Search - maintenance.md delete mode 100644 .gitlab/issue_templates/Navigation - Left Sidebar Proposals.md create mode 100644 .gitlab/issue_templates/Navigation Proposals.md (limited to '.gitlab/issue_templates') diff --git a/.gitlab/issue_templates/Broken Master - Flaky.md b/.gitlab/issue_templates/Broken Master - Flaky.md index 6b56845ba8c..bea12615e41 100644 --- a/.gitlab/issue_templates/Broken Master - Flaky.md +++ b/.gitlab/issue_templates/Broken Master - Flaky.md @@ -16,10 +16,13 @@ Please read the below documentations for a workflow of triaging and resolving br +Please refer to [Flaky tests documentation](https://docs.gitlab.com/ee/development/testing_guide/flaky_tests.html) to +learn more about how to reproduce them. + ### Proposed Resolution Please refer to the [Resolution guidance](https://about.gitlab.com/handbook/engineering/workflow/#resolution-of-broken-master) to learn more about resolution of broken master. -/label ~"failure::flaky-test" ~"Engineering Productivity" ~"priority::2" ~"severity::2" +/label ~"failure::flaky-test" ~"Engineering Productivity" ~"priority::2" ~"severity::3" ~"type::bug" ~"bug::transient" diff --git a/.gitlab/issue_templates/Broken Master - Non-flaky.md b/.gitlab/issue_templates/Broken Master - Non-flaky.md index 97a34aa759d..43e73fc5c5a 100644 --- a/.gitlab/issue_templates/Broken Master - Non-flaky.md +++ b/.gitlab/issue_templates/Broken Master - Non-flaky.md @@ -21,4 +21,4 @@ Please read the below documentations for a workflow of triaging and resolving br Please refer to the [Resolution guidance](https://about.gitlab.com/handbook/engineering/workflow/#resolution-of-broken-master) to learn more about resolution of broken master. -/label ~"master:broken" ~"Engineering Productivity" ~"priority::1" ~"severity::1" +/label ~"master:broken" ~"Engineering Productivity" ~"priority::1" ~"severity::1" ~"type::bug" ~"bug::transient" diff --git a/.gitlab/issue_templates/Doc_cleanup.md b/.gitlab/issue_templates/Doc_cleanup.md index 79cf2662b07..3ea692ed1ac 100644 --- a/.gitlab/issue_templates/Doc_cleanup.md +++ b/.gitlab/issue_templates/Doc_cleanup.md @@ -1,72 +1,38 @@ +/labels ~"documentation" ~"docs-only" ~"documentation" ~"docs::improvement" ~"type::maintenance" ~"maintenance::refactor" ~"Seeking community contributions" ~"quick win" ~"Technical Writing" + -If you are a community contributor, **do not work on the issue if it is not assigned to you yet**. - -Additionally, please review these points before working on this issue: - -1. If you would like to work on the issue, type `@gl-docsteam I would like to work on this issue.` - in a comment. A technical writer will assign the issue to you. If someone has already chosen this issue, - pick another issue, or view docs [in the docs directory](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc) - and open a merge request for any page you feel can be improved. -1. Carefully review the [merge request guidelines for contributors](https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html#merge-request-guidelines-for-contributors). -1. Carefully review the [commit message guidelines](https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html#commit-messages-guidelines). -1. Create a merge request for the issue: - - If you were not assigned the issue, do not create a merge request. It will not be accepted. - - If this is for a Hackathon, do not create the merge request before the Hackathon has started - or it will not be counted towards the Hackathon. - - Unless otherwise stated below, we expect one merge request per issue, so combine - all changes together. If there is too much work for you to handle in one merge request, - you can create more, but try to keep the number of merge requests as small as possible. - - Select the **Documentation** merge request description template, and fill it out - with the details of your work. - - Copy the link to this issue and add it to the merge request's description, - which links the merge request and the issue together. -1. After your merge request is accepted and merged, close this issue. +## Hi community contributors! :wave: -If you notice things you'd like to fix that are not part of the issue, open separate merge requests for those issues. +Do you want to work on this issue? -We're sorry for all the rules but we want everyone to have a good experience, and it can be hard when we get an influx of contributions. +- **If the issue is unassigned**, in a comment, type `@docs-hackathon I would like to work on this issue` and a writer will assign it to you. -Thank you again for contributing to the GitLab documentation! +- **If the issue is assigned to someone already**, choose another issue. Do not open a merge request for this issue if you are not assigned. -## Identified documentation issue +## To resolve the issue - - -## Additional information - - +[Follow these instructions to create a merge request](https://docs.gitlab.com/ee/development/documentation/workflow.html#how-to-update-the-docs). -### Who can address the issue +- Don't submit your merge request until after the Hackathon has started. +- Try to address the issue in a single merge request. +- 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. +- When you create the merge request, select the **Documentation** merge request description template. +- In the merge request's description, add a link to this issue. +- Follow the [commit message guidelines](https://docs.gitlab.com/ee/development/contributing/merge_request_workflow.html#commit-messages-guidelines). + Use three to five words for your commit message, start with message with a capital letter, and do **not** end it in a period. + Other commit messages can cause the pipeline to fail. - +Thank you again for contributing to the GitLab documentation! :tada: -### Other links/references +## Documentation issue - -/label ~documentation diff --git a/.gitlab/issue_templates/Feature Flag Roll Out.md b/.gitlab/issue_templates/Feature Flag Roll Out.md index 40ee1c125da..3972368ddc4 100644 --- a/.gitlab/issue_templates/Feature Flag Roll Out.md +++ b/.gitlab/issue_templates/Feature Flag Roll Out.md @@ -66,9 +66,12 @@ _Consider adding links to check for Sentry errors, Production logs for 5xx, 302s ## Rollout Steps +Note: Please make sure to run the chatops commands in the slack channel that gets impacted by the command. + ### Rollout on non-production environments -- Ensure that the feature MRs have been deployed to non-production environments. +- [ ] Verify the MR with the feature flag is merged to master. +- Verify that the feature MRs have been deployed to non-production environments with: - [ ] `/chatops run auto_deploy status ` - [ ] Enable the feature globally on non-production environments. - [ ] `/chatops run feature set true --dev --staging --staging-ref` @@ -79,13 +82,16 @@ _Consider adding links to check for Sentry errors, Production logs for 5xx, 302s ### Specific rollout on production +For visibility, all `/chatops` commands that target production should be executed in the `#production` slack channel and cross-posted (with the command results) to the responsible team's slack channel (`#g_TEAM_NAME`). + - Ensure that the feature MRs have been deployed to both production and canary. - [ ] `/chatops run auto_deploy status ` -- If you're using [project-actor](https://docs.gitlab.com/ee/development/feature_flags/#feature-actors), you must enable the feature on these entries: +- Depending on the [type of actor](https://docs.gitlab.com/ee/development/feature_flags/#feature-actors) you are using, pick one of these options: + - If you're using **project-actor**, you must enable the feature on these entries: - [ ] `/chatops run feature set --project=gitlab-org/gitlab,gitlab-org/gitlab-foss,gitlab-com/www-gitlab-com true` -- If you're using [group-actor](https://docs.gitlab.com/ee/development/feature_flags/#feature-actors), you must enable the feature on these entries: + - If you're using **group-actor**, you must enable the feature on these entries: - [ ] `/chatops run feature set --group=gitlab-org,gitlab-com true` -- If you're using [user-actor](https://docs.gitlab.com/ee/development/feature_flags/#feature-actors), you must enable the feature on these entries: + - If you're using **user-actor**, you must enable the feature on these entries: - [ ] `/chatops run feature set --user= true` - [ ] Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable. @@ -124,7 +130,7 @@ To do so, follow these steps: - [ ] Create a merge request with the following changes. Ask for review and merge it. - [ ] Set the `default_enabled` attribute in [the feature flag definition](https://docs.gitlab.com/ee/development/feature_flags/#feature-flag-definition-and-validation) to `true`. - - [ ] Create [a changelog entry](https://docs.gitlab.com/ee/development/feature_flags/#changelog). + - [ ] Review [what warrants a changelog entry](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry) and decide if [a changelog entry](https://docs.gitlab.com/ee/development/feature_flags/#changelog) is needed. - [ ] Ensure that the default-enabling MR has been included in the release package. If the merge request was deployed before [the monthly release was tagged](https://about.gitlab.com/handbook/engineering/releases/#self-managed-releases-1), the feature can be officially announced in a release blog post. @@ -165,7 +171,7 @@ You can either [create a follow-up issue for Feature Flag Cleanup](https://gitla the feature can be officially announced in a release blog post. - [ ] `/chatops run release check ` - [ ] Close [the feature issue][main-issue] to indicate the feature will be released in the current milestone. -- [ ] If not already done, clean up the feature flag from all environments by running these chatops command in `#production` channel: +- [ ] Clean up the feature flag from all environments by running these chatops command in `#production` channel: - [ ] `/chatops run feature delete --dev --staging --staging-ref --production` - [ ] Close this rollout issue. diff --git a/.gitlab/issue_templates/Geo Replicate a new Git repository type.md b/.gitlab/issue_templates/Geo Replicate a new Git repository type.md index 2348fa5b86f..571b0db0a30 100644 --- a/.gitlab/issue_templates/Geo Replicate a new Git repository type.md +++ b/.gitlab/issue_templates/Geo Replicate a new Git repository type.md @@ -94,11 +94,19 @@ Geo secondary sites have a [Geo tracking database](https://gitlab.com/gitlab-org - [ ] If deviating from the above example, then be sure to order columns according to [our guidelines](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/development/ordering_table_columns.md). -- [ ] Add the new table to the GitLab Schema defined in [`ee/lib/ee/gitlab/database/gitlab_schemas.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/ee/gitlab/database/gitlab_schemas.yml). - - ```yaml - cool_widget_registry: :gitlab_geo - ``` +- [ ] Add the new table to the [database dictionary](database_dictionary.md) defined in [`ee/db/docs/`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/ee/db/docs): + + ```yaml + table_name: cool_widget_registry + description: Description example + introduced_by_url: Merge request link + milestone: Milestone example + feature_categories: + - Feature category example + classes: + - Class example + gitlab_schema: gitlab_geo + ``` - [ ] Run Geo tracking database migrations: @@ -157,11 +165,19 @@ The Geo primary site needs to checksum every replicable so secondaries can verif - [ ] If deviating from the above example, then be sure to order columns according to [our guidelines](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/development/ordering_table_columns.md). -- [ ] Add the new table to the GitLab Schema defined in [`lib/gitlab/database/gitlab_schemas.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/database/gitlab_schemas.yml) with the databases they need to be added to. - - ```yaml - cool_widget_states: :gitlab_main - ``` +- [ ] Add the new table to the [database dictionary](database_dictionary.md) defined in [`db/docs/`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/db/docs): + + ```yaml + table_name: cool_widget_states + description: Description example + introduced_by_url: Merge request link + milestone: Milestone example + feature_categories: + - Feature category example + classes: + - Class example + gitlab_schema: gitlab_main + ``` - [ ] Run database migrations: @@ -316,6 +332,15 @@ That's all of the required database changes. true end + override :housekeeping_enabled? + def self.housekeeping_enabled? + # Remove this method if the new Git repository type supports git + # repository housekeeping and the ::CoolWidget#git_garbage_collect_worker_klass + # is implemented. If the data type requires any action to be performed + # before running the housekeeping override the `before_housekeeping` method + # (see `RepositoryReplicatorStrategy#before_housekeeping`) + false + end end end ``` diff --git a/.gitlab/issue_templates/Geo Replicate a new blob type.md b/.gitlab/issue_templates/Geo Replicate a new blob type.md index 2bb8918df60..121dbdf035f 100644 --- a/.gitlab/issue_templates/Geo Replicate a new blob type.md +++ b/.gitlab/issue_templates/Geo Replicate a new blob type.md @@ -94,11 +94,19 @@ Geo secondary sites have a [Geo tracking database](https://gitlab.com/gitlab-org - [ ] If deviating from the above example, then be sure to order columns according to [our guidelines](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/development/ordering_table_columns.md). -- [ ] Add the new table to the GitLab Schema defined in [`ee/lib/ee/gitlab/database/gitlab_schemas.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/ee/gitlab/database/gitlab_schemas.yml). - - ```yaml - cool_widget_registry: :gitlab_geo - ``` +- [ ] Add the new table to the [database dictionary](database_dictionary.md) defined in [`ee/db/docs/`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/ee/db/docs): + + ```yaml + table_name: cool_widget_registry + description: Description example + introduced_by_url: Merge request link + milestone: Milestone example + feature_categories: + - Feature category example + classes: + - Class example + gitlab_schema: gitlab_geo + ``` - [ ] Run Geo tracking database migrations: @@ -159,11 +167,19 @@ The Geo primary site needs to checksum every replicable so secondaries can verif - [ ] If deviating from the above example, then be sure to order columns according to [our guidelines](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/development/ordering_table_columns.md). -- [ ] Add the new table to the GitLab Schema defined in [`lib/gitlab/database/gitlab_schemas.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/database/gitlab_schemas.yml) with the databases they need to be added to. - - ```yaml - cool_widget_states: :gitlab_main - ``` +- [ ] Add the new table to the database dictionary defined in [`db/docs/`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/db/docs): + + ```yaml + table_name: cool_widget_states + description: Description example + introduced_by_url: Merge request link + milestone: Milestone example + feature_categories: + - Feature category example + classes: + - Class example + gitlab_schema: gitlab_main + ``` - [ ] Run database migrations: diff --git a/.gitlab/issue_templates/Global Search - bug.md b/.gitlab/issue_templates/Global Search - bug.md new file mode 100644 index 00000000000..2f568fe32bc --- /dev/null +++ b/.gitlab/issue_templates/Global Search - bug.md @@ -0,0 +1,30 @@ +## Summary + + + +## Steps to reproduce + + + +## What is the current *bug* behavior? + + + +## What is the expected *correct* behavior? + + + +## Relevant logs and/or screenshots + + + +## Possible fixes + + + + +/label ~"type::bug" +/label ~"group::global search" +/label ~"workflow::solution validation" +/milestone %Backlog \ No newline at end of file diff --git a/.gitlab/issue_templates/Global Search - feature.md b/.gitlab/issue_templates/Global Search - feature.md new file mode 100644 index 00000000000..ebc4248b7fd --- /dev/null +++ b/.gitlab/issue_templates/Global Search - feature.md @@ -0,0 +1,13 @@ +## Problem to solve + + + +## Proposal + + + + +/label ~"type::feature" +/label ~"group::global search" +/label ~"workflow::solution validation" +/milestone %Backlog \ No newline at end of file diff --git a/.gitlab/issue_templates/Global Search - maintenance.md b/.gitlab/issue_templates/Global Search - maintenance.md new file mode 100644 index 00000000000..38ce56479f2 --- /dev/null +++ b/.gitlab/issue_templates/Global Search - maintenance.md @@ -0,0 +1,11 @@ +## Background + +## Proposal + + + + +/label ~"type::maintenance" +/label ~"group::global search" +/label ~"workflow::solution validation" +/milestone %Backlog \ No newline at end of file diff --git a/.gitlab/issue_templates/Navigation - Left Sidebar Proposals.md b/.gitlab/issue_templates/Navigation - Left Sidebar Proposals.md deleted file mode 100644 index 3939fca44f1..00000000000 --- a/.gitlab/issue_templates/Navigation - Left Sidebar Proposals.md +++ /dev/null @@ -1,14 +0,0 @@ - - -### Proposal - - - -### Checklist - -- [ ] If your proposal includes changes to the menu items within the left sidebar, engage the [Foundations Product Manager](https://about.gitlab.com/handbook/product/categories/#foundations-group) for approval. The Foundations DRI will work with UX partners in product design, research, and technical writing, as applicable. -- [ ] Follow the [product development workflow](https://about.gitlab.com/handbook/product-development-flow/#validation-phase-2-problem-validation) validation process to ensure you are solving a well understood problem and that the proposed change is understandable and non-disruptive to users. Navigation-specific research is strongly encouraged. -- [ ] Engage the [Foundations](https://about.gitlab.com/handbook/product/categories/#foundations-group) team to ensure your proposal is in alignment with holistic changes happening to the left side bar. -- [ ] Consider whether you need to communicate the change somehow, or if you will have an interim period in the UI where your nav item will live in more than one place. - -/label ~UX ~"UI text" ~"documentation" ~"documentation" ~"Category:Navigation & Settings" ~"Category:Foundations" ~navigation diff --git a/.gitlab/issue_templates/Navigation Proposals.md b/.gitlab/issue_templates/Navigation Proposals.md new file mode 100644 index 00000000000..72c8f43cc97 --- /dev/null +++ b/.gitlab/issue_templates/Navigation Proposals.md @@ -0,0 +1,15 @@ + + +### Proposal + + + +### Checklist + +- [ ] Add relevant information to the issue description detailing your proposal, including usage and business drivers. +- [ ] Follow the [product development workflow](https://about.gitlab.com/handbook/product-development-flow/#validation-phase-2-problem-validation) validation process to ensure you are solving a well understood problem and that the proposed change is understandable and non-disruptive to users. Navigation-specific research is strongly encouraged. +- [ ] Engage the [Foundations Product Manager](https://about.gitlab.com/handbook/product/categories/#foundations-group) for approval. The Foundations DRI will work with UX partners in product design, research, and technical writing, as applicable. +- [ ] Engage the [Foundations](https://about.gitlab.com/handbook/product/categories/#foundations-group) team to ensure your proposal is in alignment with holistic changes happening to the left side bar. +- [ ] Consider whether you need to communicate the change somehow, or if you will have an interim period in the UI where your nav item will live in more than one place. + +/label ~UX ~"UI text" ~"documentation" ~"documentation" ~"Category:Navigation & Settings" ~"Category:Foundations" ~navigation diff --git a/.gitlab/issue_templates/Security developer workflow.md b/.gitlab/issue_templates/Security developer workflow.md index daad4c19803..7c6c86f5e78 100644 --- a/.gitlab/issue_templates/Security developer workflow.md +++ b/.gitlab/issue_templates/Security developer workflow.md @@ -10,11 +10,11 @@ Set the title to: `Description of the original issue` - [ ] Read the [security process for developers] if you are not familiar with it. - [ ] Make sure the [issue really needs to follow the security release workflow]. +- [ ] Add a `~severity::x` label to the issue and all associated merge requests. - [ ] **IMPORTANT**: Mark this [issue as linked] to the Security Release Tracking Issue. You can find it [here](https://gitlab.com/gitlab-org/gitlab/-/issues?sort=created_date&state=opened&label_name[]=upcoming+security+release). This issue MUST be linked for the release bot to know that the associated merge requests should be merged for this security release. - Fill out the [Links section](#links): - [ ] Next to **Issue on GitLab**, add a link to the `gitlab-org/gitlab` issue that describes the security vulnerability. -- [ ] Add one of the `~severity::x` labels to the issue and all associated merge requests. - [ ] If this change affects the public interface (public API or UI) of the product, post in the `#support_gitlab-com` Slack channel to explain the impact and discuss a mitigation plan for users that might be affected. If you need Support feedback or approval, reach out in `#spt_managers` Slack channel or mention `@gitlab-com/support/managers`. ## Development @@ -38,6 +38,8 @@ After your merge request has been approved according to our [approval guidelines ## Documentation and final details +- [ ] To avoid release delays, please nominate a developer in a different timezone who will be able to respond to any pipeline or merge failures in your absence `@gitlab-username` +- [ ] Ensure `~severity::x` label is on this issue, all associated issues, and merge requests - [ ] Ensure the [Links section](#links) is completed. - [ ] Add the GitLab [versions](https://gitlab.com/gitlab-org/release/docs/-/blob/master/general/security/developer.md#versions-affected) and editions affected to the [details section](#details) * The Git history of the files affected may help you associate the issue with a [release](https://about.gitlab.com/releases/) diff --git a/.gitlab/issue_templates/UX Theme.md b/.gitlab/issue_templates/UX Theme.md index 2ba60523e20..b015c3d44e6 100644 --- a/.gitlab/issue_templates/UX Theme.md +++ b/.gitlab/issue_templates/UX Theme.md @@ -1,11 +1,11 @@ - -### UX Theme - + ---- @@ -21,8 +21,8 @@ One of the advantages of working with UX themes is that it allows us to think an #### Need & Primary JTBD - **JTBD:** @@ -44,16 +44,29 @@ One of the advantages of working with UX themes is that it allows us to think an | --- | --- | | [High/Medium/Low] | [research/insight issue](Link) | +### User-stories + -### Subthemes & Requirements - +### Requirements + -Note: if feature issues already exist then you can add them to this table. Keep in mind that subthemes require validation if they are assumptive +The beneficieray needs to be able to: +- [need here] +- [need here] +- [need here] +- [etc.] + +#### Feature/solution issues + @@ -64,7 +77,7 @@ Refer to https://about.gitlab.com/handbook/product/ux/product-designer/#ux-issue | [Issue](link) | `0 - 10` | | [Issue](link) | `0 - 10` | -#### Research subthemes +#### Research @@ -73,5 +86,17 @@ Refer to https://about.gitlab.com/handbook/product/ux/product-designer/#ux-issue | [Issue]() | | | | [Issue]() | | | +#### Ready for design checklist +The items are self-check suggestions; they could be contributed by designers, product managers or researchers +* [ ] The stated `Problem to solve` has high confidence (derived from research or other data-gathering techniques) +* [ ] Relevant issues, research, and other background information are linked to the Related issues section +* [ ] The stated `Beneficiary` has been defined +* [ ] There is high confidence in the stated `Need & Primary JTBD` (derived from research or other data gathering techniques) +* [ ] The `Expected outcome` has been defined +* [ ] The `Business objective` has been defined +* [ ] The theme `Confidence` has been defined as High +* [ ] `User-stories` have been defined +* [ ] The `Requirements` have been defined and the scope has been agreed upon +* [ ] This UX Theme contains everyhting necessary to complete a design solution and is ready for design /label ~"UX" ~"UX Theme" -- cgit v1.2.3