Add latest changes from gitlab-org/gitlab@master
This commit is contained in:
parent
d1b3784799
commit
88b04d72ad
|
@ -1,5 +1,24 @@
|
|||
import { logError } from '~/lib/logger';
|
||||
|
||||
const SKU_PREMIUM = '2c92a00d76f0d5060176f2fb0a5029ff';
|
||||
const SKU_ULTIMATE = '2c92a0ff76f0d5250176f2f8c86f305a';
|
||||
const PRODUCT_INFO = {
|
||||
[SKU_PREMIUM]: {
|
||||
// eslint-disable-next-line @gitlab/require-i18n-strings
|
||||
name: 'Premium',
|
||||
id: '0002',
|
||||
price: 228,
|
||||
variant: 'SaaS',
|
||||
},
|
||||
[SKU_ULTIMATE]: {
|
||||
// eslint-disable-next-line @gitlab/require-i18n-strings
|
||||
name: 'Ultimate',
|
||||
id: '0001',
|
||||
price: 1188,
|
||||
variant: 'SaaS',
|
||||
},
|
||||
};
|
||||
|
||||
const isSupported = () => Boolean(window.dataLayer) && gon.features?.gitlabGtmDatalayer;
|
||||
|
||||
const pushEvent = (event, args = {}) => {
|
||||
|
@ -17,6 +36,23 @@ const pushEvent = (event, args = {}) => {
|
|||
}
|
||||
};
|
||||
|
||||
const pushEnhancedEcommerceEvent = (event, currencyCode, args = {}) => {
|
||||
if (!window.dataLayer) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
window.dataLayer.push({ ecommerce: null });
|
||||
window.dataLayer.push({
|
||||
event,
|
||||
currencyCode,
|
||||
...args,
|
||||
});
|
||||
} catch (e) {
|
||||
logError('Unexpected error while pushing to dataLayer', e);
|
||||
}
|
||||
};
|
||||
|
||||
const pushAccountSubmit = (accountType, accountMethod) =>
|
||||
pushEvent('accountSubmit', { accountType, accountMethod });
|
||||
|
||||
|
@ -120,3 +156,35 @@ export const trackSaasTrialGetStarted = () => {
|
|||
pushEvent('saasTrialGetStarted');
|
||||
});
|
||||
};
|
||||
|
||||
export const trackCheckout = (selectedPlan, quantity) => {
|
||||
if (!isSupported()) {
|
||||
return;
|
||||
}
|
||||
|
||||
const product = PRODUCT_INFO[selectedPlan];
|
||||
|
||||
if (!product) {
|
||||
logError('Unexpected product sku provided to trackCheckout');
|
||||
return;
|
||||
}
|
||||
|
||||
const selectedProductData = {
|
||||
...product,
|
||||
brand: 'GitLab',
|
||||
category: 'DevOps',
|
||||
quantity,
|
||||
};
|
||||
|
||||
const eventData = {
|
||||
ecommerce: {
|
||||
checkout: {
|
||||
actionField: { step: 1 },
|
||||
products: [selectedProductData],
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
// eslint-disable-next-line @gitlab/require-i18n-strings
|
||||
pushEnhancedEcommerceEvent('EECCheckout', 'USD', eventData);
|
||||
};
|
||||
|
|
|
@ -0,0 +1,15 @@
|
|||
- name: "OAuth implicit grant" # The name of the feature to be deprecated
|
||||
announcement_milestone: "14.0" # The milestone when this feature was first announced as deprecated.
|
||||
announcement_date: "2021-06-22" # The date of the milestone release when this feature was first announced as deprecated. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post.
|
||||
removal_milestone: "15.0" # The milestone when this feature is planned to be removed
|
||||
removal_date: 2022-05-22 # The date of the milestone release when this feature was first announced as deprecated. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post.
|
||||
breaking_change: yes # If this deprecation is a breaking change, set this value to true
|
||||
body: | # Do not modify this line, instead modify the lines below.
|
||||
The OAuth implicit grant authorization flow will be removed in our next major release, GitLab 15.0. Any applications that use OAuth implicit grant should switch to alternative [supported OAuth flows](https://docs.gitlab.com/ee/api/oauth2.html).
|
||||
# The following items are not published on the docs page, but may be used in the future.
|
||||
stage: # Manage
|
||||
tiers: # (optional - may be required in the future) An array of tiers that the feature is available in currently. e.g., [Free, Silver, Gold, Core, Premium, Ultimate]
|
||||
issue_url: # https://gitlab.com/gitlab-org/gitlab/-/issues/344609
|
||||
documentation_url: # (optional) This is a link to the current documentation page
|
||||
image_url: # (optional) This is a link to a thumbnail image depicting the feature
|
||||
video_url: # (optional) Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: concepts, howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
comments: false
|
||||
type: index
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference, howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference, howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -68,7 +68,7 @@ Adhere to the [Documentation Style Guide](styleguide/index.md). If a style stand
|
|||
|
||||
## Folder structure and files
|
||||
|
||||
See the [Structure](styleguide/index.md#structure) section of the [Documentation Style Guide](styleguide/index.md).
|
||||
See the [Folder structure](site_architecture/folder_structure.md) page.
|
||||
|
||||
## Metadata
|
||||
|
||||
|
|
|
@ -0,0 +1,98 @@
|
|||
---
|
||||
stage: none
|
||||
group: unassigned
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
# Folder structure for documentation
|
||||
|
||||
The documentation is separated by top-level audience folders [`user`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/user),
|
||||
[`administration`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/administration),
|
||||
and [`development`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/development)
|
||||
(contributing) folders.
|
||||
|
||||
Beyond that, we primarily follow the structure of the GitLab user interface or
|
||||
API.
|
||||
|
||||
Our goal is to have a clear hierarchical structure with meaningful URLs like
|
||||
`docs.gitlab.com/user/project/merge_requests/`. With this pattern, you can
|
||||
immediately tell that you are navigating to user-related documentation about
|
||||
Project features; specifically about Merge Requests. Our site's paths match
|
||||
those of our repository, so the clear structure also makes documentation easier
|
||||
to update.
|
||||
|
||||
Put files for a specific product area into the related folder:
|
||||
|
||||
| Directory | Contents |
|
||||
|:----------------------|:------------------|
|
||||
| `doc/user/` | Documentation for users. Anything that can be done in the GitLab user interface goes here, including usage of the `/admin` interface. |
|
||||
| `doc/administration/` | Documentation that requires the user to have access to the server where GitLab is installed. Administrator settings in the GitLab user interface are under `doc/user/admin_area/`. |
|
||||
| `doc/api/` | Documentation for the API. |
|
||||
| `doc/development/` | Documentation related to the development of GitLab, whether contributing code or documentation. Related process and style guides should go here. |
|
||||
| `doc/legal/` | Legal documents about contributing to GitLab. |
|
||||
| `doc/install/` | Instructions for installing GitLab. |
|
||||
| `doc/update/` | Instructions for updating GitLab. |
|
||||
| `doc/topics/` | Indexes per topic (`doc/topics/topic_name/index.md`): all resources for that topic. |
|
||||
|
||||
## Work with directories and files
|
||||
|
||||
When working with directories and files:
|
||||
|
||||
1. When you create a new directory, always start with an `index.md` file.
|
||||
Don't use another filename and do not create `README.md` files.
|
||||
1. Do not use special characters and spaces, or capital letters in file
|
||||
names, directory names, branch names, and anything that generates a path.
|
||||
1. When creating or renaming a file or directory and it has more than one word
|
||||
in its name, use underscores (`_`) instead of spaces or dashes. For example,
|
||||
proper naming would be `import_project/import_from_github.md`. This applies
|
||||
to both image files and Markdown files.
|
||||
1. For image files, do not exceed 100KB.
|
||||
1. Do not upload video files to the product repositories.
|
||||
[Link or embed videos](../styleguide/index.md#videos) instead.
|
||||
1. There are four main directories: `user`, `administration`, `api`, and
|
||||
`development`.
|
||||
1. The `doc/user/` directory has five main subdirectories: `project/`, `group/`,
|
||||
`profile/`, `dashboard/` and `admin_area/`.
|
||||
- `doc/user/project/` should contain all project related documentation.
|
||||
- `doc/user/group/` should contain all group related documentation.
|
||||
- `doc/user/profile/` should contain all profile related documentation.
|
||||
Every page you would navigate under `/profile` should have its own document,
|
||||
for example, `account.md`, `applications.md`, or `emails.md`.
|
||||
- `doc/user/dashboard/` should contain all dashboard related documentation.
|
||||
- `doc/user/admin_area/` should contain all administrator-related
|
||||
documentation describing what can be achieved by accessing the GitLab
|
||||
administrator interface (not to be confused with `doc/administration` where
|
||||
server access is required).
|
||||
- Every category under `/admin/application_settings/` should have its
|
||||
own document located at `doc/user/admin_area/settings/`. For example,
|
||||
the **Visibility and Access Controls** category should have a document
|
||||
located at `doc/user/admin_area/settings/visibility_and_access_controls.md`.
|
||||
1. The `doc/topics/` directory holds topic-related technical content. Create
|
||||
`doc/topics/topic_name/subtopic_name/index.md` when subtopics become necessary.
|
||||
General user and administrator documentation should be placed accordingly.
|
||||
1. The `/university/` directory is *deprecated* and the majority of its documentation
|
||||
has been moved.
|
||||
|
||||
If you're unsure where to place a document or a content addition, this shouldn't
|
||||
stop you from authoring and contributing. Use your best judgment, and then ask
|
||||
the reviewer of your MR to confirm your decision. You can also ask a technical writer at
|
||||
any stage in the process. The technical writing team reviews all
|
||||
documentation changes, regardless, and can move content if there is a better
|
||||
place for it.
|
||||
|
||||
## Avoid duplication
|
||||
|
||||
Do not include the same information in multiple places.
|
||||
[Link to a single source of truth instead.](../styleguide/index.md#link-instead-of-repeating-text)
|
||||
|
||||
## References across documents
|
||||
|
||||
- Give each folder an `index.md` page that introduces the topic, and both introduces
|
||||
and links to the child pages, including to the index pages of
|
||||
any next-level sub-paths.
|
||||
- To ensure discoverability, ensure each new or renamed doc is linked from its
|
||||
higher-level index page and other related pages.
|
||||
- When making reference to other GitLab products and features, link to their
|
||||
respective documentation, at least on first mention.
|
||||
- When making reference to third-party products or technologies, link out to
|
||||
their external sites, documentation, and resources.
|
|
@ -52,6 +52,8 @@ product, and all together are pulled to generate the docs website:
|
|||
- [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner/-/tree/main/docs)
|
||||
- [GitLab Chart](https://gitlab.com/charts/gitlab/tree/master/doc)
|
||||
|
||||
Learn more about [the docs folder structure](folder_structure.md).
|
||||
|
||||
## Assets
|
||||
|
||||
To provide an optimized site structure, design, and a search-engine friendly
|
||||
|
|
|
@ -181,115 +181,6 @@ included in backticks. For example:
|
|||
- `git clone` is a command, so it must be lowercase, while Git is the product,
|
||||
so it must have a capital G.
|
||||
|
||||
## Structure
|
||||
|
||||
We include concept and task topic types in the same larger topic.
|
||||
|
||||
In general, we have one topic that's a landing page.
|
||||
Below that topic in the left nav are individual topics. Each of these include a concept
|
||||
and multiple related tasks, reference, and troubleshooting topics.
|
||||
|
||||
### Folder structure overview
|
||||
|
||||
The documentation is separated by top-level audience folders [`user`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/user),
|
||||
[`administration`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/administration),
|
||||
and [`development`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/development)
|
||||
(contributing) folders.
|
||||
|
||||
Beyond that, we primarily follow the structure of the GitLab user interface or
|
||||
API.
|
||||
|
||||
Our goal is to have a clear hierarchical structure with meaningful URLs like
|
||||
`docs.gitlab.com/user/project/merge_requests/`. With this pattern, you can
|
||||
immediately tell that you are navigating to user-related documentation about
|
||||
Project features; specifically about Merge Requests. Our site's paths match
|
||||
those of our repository, so the clear structure also makes documentation easier
|
||||
to update.
|
||||
|
||||
Put files for a specific product area into the related folder:
|
||||
|
||||
| Directory | Contents |
|
||||
|:----------------------|:------------------|
|
||||
| `doc/user/` | Documentation for users. Anything that can be done in the GitLab user interface goes here, including usage of the `/admin` interface. |
|
||||
| `doc/administration/` | Documentation that requires the user to have access to the server where GitLab is installed. Administrator settings in the GitLab user interface are under `doc/user/admin_area/`. |
|
||||
| `doc/api/` | Documentation for the API. |
|
||||
| `doc/development/` | Documentation related to the development of GitLab, whether contributing code or documentation. Related process and style guides should go here. |
|
||||
| `doc/legal/` | Legal documents about contributing to GitLab. |
|
||||
| `doc/install/` | Instructions for installing GitLab. |
|
||||
| `doc/update/` | Instructions for updating GitLab. |
|
||||
| `doc/topics/` | Indexes per topic (`doc/topics/topic_name/index.md`): all resources for that topic. |
|
||||
|
||||
### Work with directories and files
|
||||
|
||||
When working with directories and files:
|
||||
|
||||
1. When you create a new directory, always start with an `index.md` file.
|
||||
Don't use another filename and do not create `README.md` files.
|
||||
1. Do not use special characters and spaces, or capital letters in file
|
||||
names, directory names, branch names, and anything that generates a path.
|
||||
1. When creating or renaming a file or directory and it has more than one word
|
||||
in its name, use underscores (`_`) instead of spaces or dashes. For example,
|
||||
proper naming would be `import_project/import_from_github.md`. This applies
|
||||
to both image files and Markdown files.
|
||||
1. For image files, do not exceed 100KB.
|
||||
1. Do not upload video files to the product repositories.
|
||||
[Link or embed videos](#videos) instead.
|
||||
1. There are four main directories: `user`, `administration`, `api`, and
|
||||
`development`.
|
||||
1. The `doc/user/` directory has five main subdirectories: `project/`, `group/`,
|
||||
`profile/`, `dashboard/` and `admin_area/`.
|
||||
- `doc/user/project/` should contain all project related documentation.
|
||||
- `doc/user/group/` should contain all group related documentation.
|
||||
- `doc/user/profile/` should contain all profile related documentation.
|
||||
Every page you would navigate under `/profile` should have its own document,
|
||||
for example, `account.md`, `applications.md`, or `emails.md`.
|
||||
- `doc/user/dashboard/` should contain all dashboard related documentation.
|
||||
- `doc/user/admin_area/` should contain all administrator-related
|
||||
documentation describing what can be achieved by accessing the GitLab
|
||||
administrator interface (not to be confused with `doc/administration` where
|
||||
server access is required).
|
||||
- Every category under `/admin/application_settings/` should have its
|
||||
own document located at `doc/user/admin_area/settings/`. For example,
|
||||
the **Visibility and Access Controls** category should have a document
|
||||
located at `doc/user/admin_area/settings/visibility_and_access_controls.md`.
|
||||
1. The `doc/topics/` directory holds topic-related technical content. Create
|
||||
`doc/topics/topic_name/subtopic_name/index.md` when subtopics become necessary.
|
||||
General user and administrator documentation should be placed accordingly.
|
||||
1. The `/university/` directory is *deprecated* and the majority of its documentation
|
||||
has been moved.
|
||||
|
||||
If you're unsure where to place a document or a content addition, this shouldn't
|
||||
stop you from authoring and contributing. Use your best judgment, and then ask
|
||||
the reviewer of your MR to confirm your decision. You can also ask a technical writer at
|
||||
any stage in the process. The technical writing team reviews all
|
||||
documentation changes, regardless, and can move content if there is a better
|
||||
place for it.
|
||||
|
||||
### Avoid duplication
|
||||
|
||||
Do not include the same information in multiple places.
|
||||
[Link to a single source of truth instead.](#link-instead-of-repeating-text)
|
||||
|
||||
### References across documents
|
||||
|
||||
- Give each folder an `index.md` page that introduces the topic, and both introduces
|
||||
and links to the child pages, including to the index pages of
|
||||
any next-level sub-paths.
|
||||
- To ensure discoverability, ensure each new or renamed doc is linked from its
|
||||
higher-level index page and other related pages.
|
||||
- When making reference to other GitLab products and features, link to their
|
||||
respective documentation, at least on first mention.
|
||||
- When making reference to third-party products or technologies, link out to
|
||||
their external sites, documentation, and resources.
|
||||
|
||||
### Structure in documents
|
||||
|
||||
- Include any and all applicable subsections as described on the
|
||||
[structure and template](../structure.md) page.
|
||||
- Structure content in alphabetical order in tables, lists, and so on, unless
|
||||
there's a logical reason not to (for example, when mirroring the user
|
||||
interface or an otherwise ordered sequence).
|
||||
|
||||
## Language
|
||||
|
||||
GitLab documentation should be clear and easy to understand.
|
||||
|
|
|
@ -157,7 +157,7 @@ Ensure the following if skipping an initial Technical Writer review:
|
|||
- Specific [user permissions](../../user/permissions.md) are documented.
|
||||
- New documents are linked from higher-level indexes, for discoverability.
|
||||
- The style guide is followed:
|
||||
- For [directories and files](styleguide/index.md#work-with-directories-and-files).
|
||||
- For [directories and files](site_architecture/folder_structure.md).
|
||||
- For [images](styleguide/index.md#images).
|
||||
|
||||
Merge requests that change the location of documentation must always be reviewed by a Technical
|
||||
|
|
|
@ -21,7 +21,7 @@ We have two kinds of changes related to JH:
|
|||
- We will generalize this so both EE and JH can share the same mechanism,
|
||||
then we wouldn't have to treat them differently.
|
||||
|
||||
If needed, review the corresponding JH merge request located at [JH repository](https://jihulab.com/gitlab-cn/gitlab)
|
||||
If needed, review the corresponding JH merge request located at [JH repository](https://jihulab.com/gitlab-cn/gitlab).
|
||||
|
||||
## When to merge files to the GitLab Inc. repository
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -226,7 +226,7 @@ of [GitLab JH](jh_features_review.md). These jobs are only created in the follow
|
|||
|
||||
The `* as-if-jh` jobs are run in addition to the regular EE-context jobs. The `jh/` folder is added before the tests start running.
|
||||
|
||||
The intent is to ensure that a change doesn't introduce a failure after the `gitlab-org/gitlab` is synced to [GitLab JH](https://jihulab.com/gitlab-cn/gitlab).
|
||||
The intent is to ensure that a change doesn't introduce a failure after `gitlab-org/gitlab` is synced to [GitLab JH](https://jihulab.com/gitlab-cn/gitlab).
|
||||
|
||||
### Corresponding JH branch
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -120,3 +120,5 @@ Similarly to specifying that a test should only run against a specific environme
|
|||
test only when it runs against a specific environment. The syntax is exactly the same, except that the `only: { ... }`
|
||||
hash is nested in the [`quarantine: { ... }`](https://about.gitlab.com/handbook/engineering/quality/guidelines/debugging-qa-test-failures/#quarantining-tests) hash.
|
||||
For example, `quarantine: { only: { subdomain: :staging } }` only quarantines the test when run against `staging`.
|
||||
|
||||
The quarantine feature can be explicitly disabled with the `DISABLE_QUARANTINE` environment variable. This can be useful when running tests locally.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
comments: false
|
||||
type: index
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: concepts
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference, howto
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference, howto
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference, howto
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: howto
|
||||
---
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference, howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference
|
||||
---
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: howto
|
||||
---
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: concepts, reference, howto
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"
|
||||
type: howto, reference
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -58,6 +58,18 @@ We encourage customers currently using NFS for Git repositories to plan their mi
|
|||
|
||||
**Planned removal milestone: 15.0 (2022-05-22)**
|
||||
|
||||
### OAuth implicit grant
|
||||
|
||||
WARNING:
|
||||
This feature will be changed or removed in 15.0
|
||||
as a [breaking change](https://docs.gitlab.com/ee/development/contributing/#breaking-changes).
|
||||
Before updating GitLab, review the details carefully to determine if you need to make any
|
||||
changes to your code, settings, or workflow.
|
||||
|
||||
The OAuth implicit grant authorization flow will be removed in our next major release, GitLab 15.0. Any applications that use OAuth implicit grant should switch to alternative [supported OAuth flows](https://docs.gitlab.com/ee/api/oauth2.html).
|
||||
|
||||
**Planned removal milestone: 15.0 (2022-05-22)**
|
||||
|
||||
## 14.2
|
||||
|
||||
### Release CLI distributed as a generic package
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: howto
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: howto
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference, howto
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference, howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference, howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference, howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: howto, reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"
|
||||
type: reference, howto
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
type: reference, howto, concepts
|
||||
---
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
@ -298,7 +298,6 @@ The following table lists group permissions available for each role:
|
|||
| Action | Guest | Reporter | Developer | Maintainer | Owner |
|
||||
|--------------------------------------------------------------------------|-------|----------|-----------|------------|-------|
|
||||
| Browse group | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||
| Edit SAML SSO Billing **(PREMIUM SAAS)** | ✓ | ✓ | ✓ | ✓ | ✓ (4) |
|
||||
| Pull a container image using the dependency proxy | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||
| View Contribution analytics | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||
| View group epic **(PREMIUM)** | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||
|
@ -338,6 +337,7 @@ The following table lists group permissions available for each role:
|
|||
| Delete group epic **(PREMIUM)** | | | | | ✓ |
|
||||
| Disable notification emails | | | | | ✓ |
|
||||
| Edit group settings | | | | | ✓ |
|
||||
| Edit SAML SSO **(PREMIUM SAAS)** | | | | | ✓ (4) |
|
||||
| Filter members by 2FA status | | | | | ✓ |
|
||||
| Manage group level CI/CD variables | | | | | ✓ |
|
||||
| Manage group members | | | | | ✓ |
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: reference
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: index, howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
type: concepts, howto
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
||||
---
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
stage: Manage
|
||||
group: Authentication & Authorization
|
||||
group: Authentication and Authorization
|
||||
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"
|
||||
type: reference, howto
|
||||
---
|
||||
|
|
|
@ -438,6 +438,10 @@ module QA
|
|||
ENV['QA_EE_ACTIVATION_CODE']
|
||||
end
|
||||
|
||||
def quarantine_disabled?
|
||||
enabled?(ENV['DISABLE_QUARANTINE'], default: false)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def remote_grid_credentials
|
||||
|
|
|
@ -10,8 +10,10 @@ module QA
|
|||
|
||||
extend self
|
||||
|
||||
# Skip tests in quarantine unless we explicitly focus on them.
|
||||
# Skip tests in quarantine unless we explicitly focus on them or quarantine disabled
|
||||
def skip_or_run_quarantined_tests_or_contexts(example)
|
||||
return if Runtime::Env.quarantine_disabled?
|
||||
|
||||
if filters.key?(:quarantine)
|
||||
included_filters = filters_other_than_quarantine
|
||||
|
||||
|
|
|
@ -104,6 +104,20 @@ RSpec.describe QA::Specs::Helpers::Quarantine do
|
|||
end
|
||||
|
||||
describe '.skip_or_run_quarantined_tests_or_contexts' do
|
||||
context 'with explicitly disabled quarantine' do
|
||||
before do
|
||||
stub_env('DISABLE_QUARANTINE', 'true')
|
||||
end
|
||||
|
||||
it 'runs quarantined test' do
|
||||
group = describe_successfully do
|
||||
it('is pending', :quarantine) {}
|
||||
end
|
||||
|
||||
expect(group.examples.first.execution_result.status).to eq(:passed)
|
||||
end
|
||||
end
|
||||
|
||||
context 'with no tag focused' do
|
||||
it 'skips quarantined tests' do
|
||||
group = describe_successfully do
|
||||
|
|
|
@ -8,6 +8,7 @@ import {
|
|||
trackSaasTrialProject,
|
||||
trackSaasTrialProjectImport,
|
||||
trackSaasTrialGetStarted,
|
||||
trackCheckout,
|
||||
} from '~/google_tag_manager';
|
||||
import { setHTMLFixture } from 'helpers/fixtures';
|
||||
import { logError } from '~/lib/logger';
|
||||
|
@ -209,6 +210,103 @@ describe('~/google_tag_manager/index', () => {
|
|||
expect(spy).toHaveBeenCalledWith({ event: 'saasTrialSubmit' });
|
||||
expect(logError).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
describe('when trackCheckout is invoked', () => {
|
||||
it('with selectedPlan: 2c92a00d76f0d5060176f2fb0a5029ff', () => {
|
||||
expect(spy).not.toHaveBeenCalled();
|
||||
|
||||
trackCheckout('2c92a00d76f0d5060176f2fb0a5029ff', 1);
|
||||
|
||||
expect(spy).toHaveBeenCalledTimes(2);
|
||||
expect(spy).toHaveBeenCalledWith({ ecommerce: null });
|
||||
expect(spy).toHaveBeenCalledWith({
|
||||
event: 'EECCheckout',
|
||||
currencyCode: 'USD',
|
||||
ecommerce: {
|
||||
checkout: {
|
||||
actionField: { step: 1 },
|
||||
products: [
|
||||
{
|
||||
brand: 'GitLab',
|
||||
category: 'DevOps',
|
||||
id: '0002',
|
||||
name: 'Premium',
|
||||
price: 228,
|
||||
quantity: 1,
|
||||
variant: 'SaaS',
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('with selectedPlan: 2c92a0ff76f0d5250176f2f8c86f305a', () => {
|
||||
expect(spy).not.toHaveBeenCalled();
|
||||
|
||||
trackCheckout('2c92a0ff76f0d5250176f2f8c86f305a', 1);
|
||||
|
||||
expect(spy).toHaveBeenCalledTimes(2);
|
||||
expect(spy).toHaveBeenCalledWith({ ecommerce: null });
|
||||
expect(spy).toHaveBeenCalledWith({
|
||||
event: 'EECCheckout',
|
||||
currencyCode: 'USD',
|
||||
ecommerce: {
|
||||
checkout: {
|
||||
actionField: { step: 1 },
|
||||
products: [
|
||||
{
|
||||
brand: 'GitLab',
|
||||
category: 'DevOps',
|
||||
id: '0001',
|
||||
name: 'Ultimate',
|
||||
price: 1188,
|
||||
quantity: 1,
|
||||
variant: 'SaaS',
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('with selectedPlan: Something else', () => {
|
||||
expect(spy).not.toHaveBeenCalled();
|
||||
|
||||
trackCheckout('Something else', 1);
|
||||
|
||||
expect(spy).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('with a different number of users', () => {
|
||||
expect(spy).not.toHaveBeenCalled();
|
||||
|
||||
trackCheckout('2c92a0ff76f0d5250176f2f8c86f305a', 5);
|
||||
|
||||
expect(spy).toHaveBeenCalledTimes(2);
|
||||
expect(spy).toHaveBeenCalledWith({ ecommerce: null });
|
||||
expect(spy).toHaveBeenCalledWith({
|
||||
event: 'EECCheckout',
|
||||
currencyCode: 'USD',
|
||||
ecommerce: {
|
||||
checkout: {
|
||||
actionField: { step: 1 },
|
||||
products: [
|
||||
{
|
||||
brand: 'GitLab',
|
||||
category: 'DevOps',
|
||||
id: '0001',
|
||||
name: 'Ultimate',
|
||||
price: 1188,
|
||||
quantity: 5,
|
||||
variant: 'SaaS',
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe.each([
|
||||
|
|
Loading…
Reference in New Issue