diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-02 18:08:01 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-02 18:08:01 +0300 |
commit | b375c6c05fbd03aea33a9ee9f82e678bdaa8c3cc (patch) | |
tree | 55f2a32e5fd3d67597fc8c6cc2a01793ee15c87a /doc | |
parent | 988b28ec1a379d38f6ac9ed04886ee564fd447fd (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/fe_guide/dependencies.md | 40 | ||||
-rw-r--r-- | doc/development/fe_guide/index.md | 44 | ||||
-rw-r--r-- | doc/ssh/README.md | 4 | ||||
-rw-r--r-- | doc/user/project/pipelines/settings.md | 8 | ||||
-rw-r--r-- | doc/user/project/repository/web_editor.md | 25 | ||||
-rw-r--r-- | doc/user/project/settings/index.md | 10 |
6 files changed, 97 insertions, 34 deletions
diff --git a/doc/development/fe_guide/dependencies.md b/doc/development/fe_guide/dependencies.md new file mode 100644 index 00000000000..0f5825992e9 --- /dev/null +++ b/doc/development/fe_guide/dependencies.md @@ -0,0 +1,40 @@ +# Frontend dependencies + +## Package manager + +We use [Yarn](https://yarnpkg.com/) to manage frontend dependencies. There are a few exceptions: + +- [FontAwesome](https://fontawesome.com/), installed via the `font-awesome-rails` gem: we are working to replace it with + [GitLab SVGs](https://gitlab-org.gitlab.io/gitlab-svgs/) icons library. +- [ACE](https://ace.c9.io/) editor, installed via the `ace-rails-ap` gem. +- Other dependencies found under `vendor/assets/`. + +## Updating dependencies + +### Renovate GitLab Bot + +We use the [Renovate GitLab Bot](https://gitlab.com/gitlab-org/frontend/renovate-gitlab-bot) to +automatically create merge requests for updating dependencies of several projects. You can find the +up-to-date list of projects managed by the renovate bot in the project’s README. Some key dependencies +updated using renovate are: + +- [`@gitlab/ui`](https://gitlab.com/gitlab-org/gitlab-ui/) +- [`@gitlab/svgs`](https://gitlab.com/gitlab-org/gitlab-svgs/) +- [`@gitlab/eslint-config`](https://gitlab.com/gitlab-org/gitlab-eslint-config) + +### Blocked dependencies + +We discourage installing some dependencies in [GitLab repository](https://gitlab.com/gitlab-org/gitlab) +because they can create conflicts in the dependency tree. Blocked dependencies are declared in the +`blockDependencies` property of GitLab’s [`package.json` file](https://gitlab.com/gitlab-org/gitlab/-/blob/master/package.json). + +## Dependency notes + +### BootstrapVue + +[BootstrapVue](https://bootstrap-vue.js.org/) is a component library built with Vue.js and Bootstrap. +We wrap BootstrapVue components in [GitLab UI](https://gitlab.com/gitlab-org/gitlab-ui/) with the +purpose of applying visual styles and usage guidelines specified in the +[Pajamas Design System](https://design.gitlab.com/). For this reason, we recommend not installing +BootstrapVue directly in the GitLab repository. Instead create a wrapper of the BootstrapVue +component you want to use in GitLab UI first. diff --git a/doc/development/fe_guide/index.md b/doc/development/fe_guide/index.md index ba77a51a089..ff69cb0e0ce 100644 --- a/doc/development/fe_guide/index.md +++ b/doc/development/fe_guide/index.md @@ -23,22 +23,22 @@ Use [BrowserStack](https://www.browserstack.com/) to test with our supported bro Current high-level frontend goals are listed on [Frontend Epics](https://gitlab.com/groups/gitlab-org/-/epics?label_name%5B%5D=frontend). -## [Principles](principles.md) +## Principles -High-level guidelines for contributing to GitLab. +[High-level guidelines](principles.md) for contributing to GitLab. -## [Development Process](development_process.md) +## Development Process -How we plan and execute the work on the frontend. +How we [plan and execute](development_process.md) the work on the frontend. -## [Architecture](architecture.md) +## Architecture -How we go about making fundamental design decisions in GitLab's frontend team +How we go about [making fundamental design decisions](architecture.md) in GitLab's frontend team or make changes to our frontend development guidelines. -## [Testing](../testing_guide/frontend_testing.md) +## Testing -How we write frontend tests, run the GitLab test suite, and debug test related +How we write [frontend tests](../testing_guide/frontend_testing.md), run the GitLab test suite, and debug test related issues. ## Pajamas Design System @@ -46,29 +46,33 @@ issues. Reusable components with technical and usage guidelines can be found in our [Pajamas Design System](https://design.gitlab.com/). -## [Design Patterns](design_patterns.md) +## Design Patterns -Common JavaScript design patterns in GitLab's codebase. +Common JavaScript [design patterns](design_patterns.md) in GitLab's codebase. -## [Vue.js Best Practices](vue.md) +## Vue.js Best Practices -Vue specific design patterns and practices. +Vue specific [design patterns and practices](vue.md). -## [Vuex](vuex.md) +## Vuex -Vuex specific design patterns and practices. +[Vuex](vuex.md) specific design patterns and practices. -## [Axios](axios.md) +## Axios -Axios specific practices and gotchas. +[Axios](axios.md) specific practices and gotchas. -## [GraphQL](graphql.md) +## GraphQL -How to use GraphQL +How to use [GraphQL](graphql.md). -## [Icons and Illustrations](icons.md) +## Icons and Illustrations -How we use SVG for our Icons and Illustrations. +How we use SVG for our [Icons and Illustrations](icons.md). + +## Dependencies + +General information about frontend [dependencies](dependencies.md) and how we manage them. ## Frontend FAQ diff --git a/doc/ssh/README.md b/doc/ssh/README.md index 07abfa4cdac..521a2a0876a 100644 --- a/doc/ssh/README.md +++ b/doc/ssh/README.md @@ -344,7 +344,7 @@ Integration (CI) server. By using deploy keys, you don't have to set up a dummy user account. If you are a project maintainer or owner, you can add a deploy key in the -project's **Settings > Repository** page by expanding the +project's **{settings}** **Settings > CI / CD** page by expanding the **Deploy Keys** section. Specify a title for the new deploy key and paste a public SSH key. After this, the machine that uses the corresponding private SSH key has read-only or read-write (if enabled) @@ -387,7 +387,7 @@ of broader usage for something like "Anywhere you need to give read access to your repository". Once a GitLab administrator adds the Global Deployment key, project maintainers -and owners can add it in project's **Settings > Repository** page by expanding the +and owners can add it in project's **{settings}** **Settings > CI / CD** page by expanding the **Deploy Keys** section and clicking **Enable** next to the appropriate key listed under **Public deploy keys available to any project**. diff --git a/doc/user/project/pipelines/settings.md b/doc/user/project/pipelines/settings.md index fe62f5e2185..d4e755dab6b 100644 --- a/doc/user/project/pipelines/settings.md +++ b/doc/user/project/pipelines/settings.md @@ -268,6 +268,14 @@ https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?st [Environment variables](../../../ci/variables/README.html#gitlab-cicd-environment-variables) can be set in an environment to be available to a runner. +## Deploy Keys + +With Deploy Keys, GitLab allows you to import SSH public keys. You can then have +read only or read/write access to your project from the machines the keys were generated from. + +SSH keys added to your project settings will be used for continuous integration, +staging, or production servers. + <!-- ## Troubleshooting Include any troubleshooting steps that you can foresee. If you know beforehand what issues diff --git a/doc/user/project/repository/web_editor.md b/doc/user/project/repository/web_editor.md index 0e47bf2c902..f1947066279 100644 --- a/doc/user/project/repository/web_editor.md +++ b/doc/user/project/repository/web_editor.md @@ -75,7 +75,7 @@ ready. To keep files in the repository organized it is often helpful to create a new directory. -From a project's files page, click the '+' button to the right of the branch selector. +From a project's files page, click the plus button (`+`) to the right of the branch selector. Choose **New directory** from the dropdown. ![New directory dropdown](img/web_editor_new_directory_dropdown.png) @@ -91,14 +91,21 @@ There are multiple ways to create a branch from GitLab's web interface. ### Create a new branch from an issue -> [Introduced][ce-2808] in GitLab 8.6. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/2808) in GitLab 8.6. + +If your development workflow dictates to have an issue for every merge +request, you can quickly create a branch directly from the issue to speed the process up. +The new branch, and later its merge request, will be marked as related to this issue. +Once merged, the MR will automatically close the issue. +You can see a **Create merge request** dropdown below the issue description. -In case your development workflow dictates to have an issue for every merge -request, you can quickly create a branch right on the issue page which will be -tied with the issue itself. You can see a **Create merge request** dropdown -below the issue description unless there is already a branch with the same -name or a referenced merge request or your project (still) has an active -[fork relationship](../settings/index.md#advanced-settings). +NOTE: **Note:** +You won't see the **Create merge request** button if there is already a branch with the same +name or a referenced merge request or your project has an active +fork relationship. +If you would like to make this button appear, a possible workaround is to [remove your project's +fork relationship](../settings/index.md#removing-a-fork-relationship). Once removed, the fork +relationship cannot be restored and you will no longer be able to send merge requests to the source. ![Create Button](img/web_editor_new_branch_from_issue_create_button_v12_6.png) @@ -181,8 +188,6 @@ If you'd prefer _not_ to use your primary email address for commits created through the web editor, you can choose to use another of your linked email addresses from the **User Settings > Edit Profile** page. -[ce-2808]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2808 - <!-- ## Troubleshooting Include any troubleshooting steps that you can foresee. If you know beforehand what issues diff --git a/doc/user/project/settings/index.md b/doc/user/project/settings/index.md index 12cc2fe665d..1deb66aacfd 100644 --- a/doc/user/project/settings/index.md +++ b/doc/user/project/settings/index.md @@ -215,9 +215,12 @@ To remove a project: This action either: - Removes a project including all associated resources (issues, merge requests etc). -- Since [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/issues/32935), on [Premium or Silver](https://about.gitlab.com/pricing/) or higher tiers, marks a project for deletion. The deletion will happen 7 days later by default, but this can be changed in the [instance settings](../../admin_area/settings/visibility_and_access_controls.md#default-deletion-adjourned-period-premium-only). +- Since [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/issues/32935), on + [GitLab Premium or GitLab.com Silver](https://about.gitlab.com/pricing/) or higher tiers, marks a project for + deletion. The deletion will happen 7 days later by default, but this can be changed in the + [instance settings](../../admin_area/settings/visibility_and_access_controls.md#default-deletion-adjourned-period-premium-only). -### Restore a project **(PREMIUM)** +#### Restore a project **(PREMIUM)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/32935) in GitLab 12.6. @@ -234,6 +237,9 @@ If you want to use the fork for yourself and don't need to send [merge requests](../merge_requests.md) to the upstream project, you can safely remove the fork relationship. +CAUTION: **Caution:** +Once removed, the fork relationship cannot be restored. You will no longer be able to send merge requests to the source, and if anyone has forked your project, their fork will also lose the relationship. + To do so: 1. Navigate to your project's **Settings > General > Advanced**. |