diff options
| author | Evan Read <eread@gitlab.com> | 2019-02-22 13:17:10 +0000 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-02-22 13:17:10 +0000 |
| commit | eb866309591f64a3cafb3c950b2cb6a0185595e8 (patch) | |
| tree | 669e1fed24babeb9d36abce149e4e01979aa6787 /doc/user | |
| parent | 0152d6ff1187c1baf25415189a0d73972875c328 (diff) | |
| download | gitlab-ce-eb866309591f64a3cafb3c950b2cb6a0185595e8.tar.gz | |
Ensure all lists are surrounded by new lines
Markdown renderers find it easier to determine
where lists start and end when lists are surrounded
by new lines.
For consistency, also ensure entries in the list
are aligned when they span multipls lines.
Diffstat (limited to 'doc/user')
27 files changed, 169 insertions, 165 deletions
diff --git a/doc/user/discussions/index.md b/doc/user/discussions/index.md index d202b1260ad..1e2fad1efe9 100644 --- a/doc/user/discussions/index.md +++ b/doc/user/discussions/index.md @@ -248,10 +248,10 @@ For large projects with many contributors, it may be useful to stop discussions in issues or merge requests in these scenarios: - The project maintainer has already resolved the discussion and it is not helpful -for continued feedback. The project maintainer has already directed new conversation -to newer issues or merge requests. + for continued feedback. The project maintainer has already directed new conversation + to newer issues or merge requests. - The people participating in the discussion are trolling, abusive, or otherwise -being unproductive. + being unproductive. In these cases, a user with Developer permissions or higher in the project can lock (and unlock) an issue or a merge request, using the "Lock" section in the sidebar. For issues, @@ -276,17 +276,17 @@ Additionally locked issues can not be reopened. ## Filtering notes -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/26723) in GitLab 11.5. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/26723) in GitLab 11.5. -For issues with many comments like activity notes and user comments, sometimes -finding useful information can be hard. There is a way to filter comments from single notes and discussions for merge requests and issues. +For issues with many comments like activity notes and user comments, sometimes +finding useful information can be hard. There is a way to filter comments from single notes and discussions for merge requests and issues. From a merge request's **Discussion** tab, or from an epic/issue overview, find the filter's dropdown menu on the right side of the page, from which you can choose one of the following options: - **Show all activity**: displays all user comments and system notes -(issue updates, mentions from other issues, changes to the description, etc). + (issue updates, mentions from other issues, changes to the description, etc). - **Show comments only**: only displays user comments in the list. -- **Show history only**: only displays activity notes. +- **Show history only**: only displays activity notes.  @@ -298,21 +298,21 @@ from any device you're logged into. > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/18008) in GitLab 11.6. -As a reviewer, you're able to suggest code changes with a simple +As a reviewer, you're able to suggest code changes with a simple markdown syntax in Merge Request Diff discussions. Then, the -Merge Request author (or other users with appropriate +Merge Request author (or other users with appropriate [permission](../permissions.md)) is able to apply these -suggestions with a click, which will generate a commit in +suggestions with a click, which will generate a commit in the Merge Request authored by the user that applied them. 1. Choose a line of code to be changed, add a new comment, then click -on the **Insert suggestion** icon in the toolbar: + on the **Insert suggestion** icon in the toolbar:  - + > **Note:** The suggestion will only affect the commented line. Multi-line - suggestions are currently not supported. Will be introduced by + suggestions are currently not supported. Will be introduced by [#53310](https://gitlab.com/gitlab-org/gitlab-ce/issues/53310). 1. In the comment, add your suggestion to the pre-populated code block: @@ -327,9 +327,9 @@ on the **Insert suggestion** icon in the toolbar:  > **Note:** - Discussions are _not_ automatically resolved. Will be introduced by + Discussions are _not_ automatically resolved. Will be introduced by [#54405](https://gitlab.com/gitlab-org/gitlab-ce/issues/54405). - + Once the author applies a suggestion, it will be marked with the **Applied** label, and GitLab will create a new commit with the message `Apply suggestion to <file-name>` and push the suggested change directly into the codebase in the merge request's branch. diff --git a/doc/user/group/index.md b/doc/user/group/index.md index 5fea683a7fd..300e0115c60 100644 --- a/doc/user/group/index.md +++ b/doc/user/group/index.md @@ -18,9 +18,9 @@ a link to the group settings. By clicking the last button you can leave that gro You can create groups for numerous reasons. To name a few: - Organize related projects under the same [namespace](#namespaces), add members to that -group and grant access to all their projects at once + group and grant access to all their projects at once - Create a group, include members of your team, and make it easier to -`@mention` all the team at once in issues and merge requests + `@mention` all the team at once in issues and merge requests - Create a group for your company members, and create [subgroups](subgroups/index.md) for each individual team. Let's say you create a group called `company-team`, and among others, you created subgroups in this group for each individual team `backend-team`, @@ -43,11 +43,11 @@ In GitLab, a namespace is a unique name to be used as a user name, a group name, For example, consider a user named Alex: 1. Alex creates an account on GitLab.com with the username `alex`; -their profile will be accessed under `https://gitlab.example.com/alex` + their profile will be accessed under `https://gitlab.example.com/alex` 1. Alex creates a group for their team with the groupname `alex-team`; -the group and its projects will be accessed under `https://gitlab.example.com/alex-team` + the group and its projects will be accessed under `https://gitlab.example.com/alex-team` 1. Alex creates a subgroup of `alex-team` with the subgroup name `marketing`; -this subgroup and its projects will be accessed under `https://gitlab.example.com/alex-team/marketing` + this subgroup and its projects will be accessed under `https://gitlab.example.com/alex-team/marketing` By doing so: @@ -107,7 +107,7 @@ Consider we have a group with two projects: - On the **Group Members** page we can now add a new user to the group. - Now because this user is a **Developer** member of the group, he automatically -gets **Developer** access to **all projects** within that group. + gets **Developer** access to **all projects** within that group. If necessary, you can increase the access level of an individual user for a specific project, by adding them again as a new member to the project with the new permission levels. @@ -267,9 +267,9 @@ Define project templates at a group-level by setting a group as a template sourc ### Advanced settings - **Projects**: view all projects within that group, add members to each project, -access each project's settings, and remove any project from the same screen. + access each project's settings, and remove any project from the same screen. - **Webhooks**: configure [webhooks](../project/integrations/webhooks.md) to your group. - **Kubernetes cluster integration**: connect your GitLab group with [Kubernetes clusters](clusters/index.md). - **Audit Events**: view [Audit Events](https://docs.gitlab.com/ee/administration/audit_events.html#audit-events) -for the group. **[STARTER ONLY]** + for the group. **[STARTER ONLY]** - **Pipelines quota**: keep track of the [pipeline quota](../admin_area/settings/continuous_integration.md) for the group. diff --git a/doc/user/index.md b/doc/user/index.md index 22506b30498..71378920ed4 100644 --- a/doc/user/index.md +++ b/doc/user/index.md @@ -38,10 +38,10 @@ GitLab is a Git-based platform that integrates a great number of essential tools - Hosting code in repositories with version control - Tracking proposals for new implementations, bug reports, and feedback with a -fully featured [Issue Tracker](project/issues/index.md#issue-tracker) + fully featured [Issue Tracker](project/issues/index.md#issue-tracker) - Organizing and prioritizing with [Issue Boards](project/issues/index.md#issue-boards) - Reviewing code in [Merge Requests](project/merge_requests/index.md) with live-preview changes per -branch with [Review Apps](../ci/review_apps/index.md) + branch with [Review Apps](../ci/review_apps/index.md) - Building, testing and deploying with built-in [Continuous Integration](../ci/README.md) - Deploying personal and professional static websites with [GitLab Pages](project/pages/index.md) - Integrating with Docker by using [GitLab Container Registry](project/container_registry.md) @@ -51,9 +51,9 @@ With GitLab Enterprise Edition, you can also: - Provide support with [Service Desk](https://docs.gitlab.com/ee/user/project/service_desk.html) - Improve collaboration with -[Merge Request Approvals](https://docs.gitlab.com/ee/user/project/merge_requests/index.html#merge-request-approvals), -[Multiple Assignees for Issues](https://docs.gitlab.com/ee/user/project/issues/multiple_assignees_for_issues.html), -and [Multiple Issue Boards](https://docs.gitlab.com/ee/user/project/issue_board.html#multiple-issue-boards) + [Merge Request Approvals](https://docs.gitlab.com/ee/user/project/merge_requests/index.html#merge-request-approvals), + [Multiple Assignees for Issues](https://docs.gitlab.com/ee/user/project/issues/multiple_assignees_for_issues.html), + and [Multiple Issue Boards](https://docs.gitlab.com/ee/user/project/issue_board.html#multiple-issue-boards) - Create formal relationships between issues with [Related Issues](https://docs.gitlab.com/ee/user/project/issues/related_issues.html) - Use [Burndown Charts](https://docs.gitlab.com/ee/user/project/milestones/burndown_charts.html) to track progress during a sprint or while working on a new version of their software. - Leverage [Elasticsearch](https://docs.gitlab.com/ee/integration/elasticsearch.html) with [Advanced Global Search](https://docs.gitlab.com/ee/user/search/advanced_global_search.html) and [Advanced Syntax Search](https://docs.gitlab.com/ee/user/search/advanced_search_syntax.html) for faster, more advanced code search across your entire GitLab instance @@ -77,12 +77,12 @@ build, test, and deploy your app with built-in GitLab CI/CD. Or, you can do it all at once, from one single project. - [Repositories](project/repository/index.md): Host your codebase in -repositories with version control and as part of a fully integrated platform. + repositories with version control and as part of a fully integrated platform. - [Issues](project/issues/index.md): Explore the best of GitLab Issues' features. - [Merge Requests](project/merge_requests/index.md): Collaborate on code, -reviews, live preview changes per branch, and request approvals with Merge Requests. + reviews, live preview changes per branch, and request approvals with Merge Requests. - [Milestones](project/milestones/index.md): Work on multiple issues and merge -requests towards the same target date with Milestones. + requests towards the same target date with Milestones. ## GitLab CI/CD @@ -92,9 +92,9 @@ directly from GitLab. No third-party integrations needed. - [GitLab Auto Deploy](../ci/autodeploy/index.md): Deploy your application out-of-the-box with GitLab Auto Deploy. - [Review Apps](../ci/review_apps/index.md): Live-preview the changes introduced by a merge request with Review Apps. - [GitLab Pages](project/pages/index.md): Publish your static site directly from -GitLab with GitLab Pages. You can build, test, and deploy any Static Site Generator with Pages. + GitLab with GitLab Pages. You can build, test, and deploy any Static Site Generator with Pages. - [GitLab Container Registry](project/container_registry.md): Build and deploy Docker -images with Container Registry. + images with Container Registry. ## Account @@ -102,13 +102,13 @@ There is a lot you can customize and configure to enjoy the best of GitLab. - [Settings](profile/index.md): Manage your user settings to change your personal info, -personal access tokens, authorized applications, etc. + personal access tokens, authorized applications, etc. - [Authentication](../topics/authentication/index.md): Read through the authentication -methods available in GitLab. + methods available in GitLab. - [Permissions](permissions.md): Learn the different set of permissions levels for each -user type (guest, reporter, developer, maintainer, owner). + user type (guest, reporter, developer, maintainer, owner). - [Feature highlight](feature_highlight.md): Learn more about the little blue dots -around the app that explain certain features + around the app that explain certain features - [Abuse reports](abuse_reports.md): Report abuse from users to GitLab administrators ## Groups diff --git a/doc/user/profile/account/two_factor_authentication.md b/doc/user/profile/account/two_factor_authentication.md index 0a7c5832a2d..8e5fe4b0fb9 100644 --- a/doc/user/profile/account/two_factor_authentication.md +++ b/doc/user/profile/account/two_factor_authentication.md @@ -41,7 +41,7 @@ or a U2F device. **On your phone:** 1. Install a compatible application. We recommend [Google Authenticator] -\(proprietary\) or [FreeOTP] \(open source\). + \(proprietary\) or [FreeOTP] \(open source\). 1. In the application, add a new entry in one of two ways: - Scan the code with your phone's camera to add the entry automatically. - Enter the details provided to add the entry manually. diff --git a/doc/user/profile/index.md b/doc/user/profile/index.md index ba756c4b793..a2b15d058d7 100644 --- a/doc/user/profile/index.md +++ b/doc/user/profile/index.md @@ -35,13 +35,13 @@ From there, you can: - Manage [2FA](account/two_factor_authentication.md) - Change your username and [delete your account](account/delete_account.md) - Manage applications that can -[use GitLab as an OAuth provider](../../integration/oauth_provider.md#introduction-to-oauth) + [use GitLab as an OAuth provider](../../integration/oauth_provider.md#introduction-to-oauth) - Manage [personal access tokens](personal_access_tokens.md) to access your account via API and authorized applications - Add and delete emails linked to your account - Choose which email to use for notifications, web-based commits, and display on your public profile - Manage [SSH keys](../../ssh/README.md#ssh) to access your account via SSH - Manage your [preferences](preferences.md#syntax-highlighting-theme) -to customize your own GitLab experience + to customize your own GitLab experience - [View your active sessions](active_sessions.md) and revoke any of them if necessary - Access your audit log, a security log of important events involving your account diff --git a/doc/user/project/cycle_analytics.md b/doc/user/project/cycle_analytics.md index 529a82ded9e..05127b274e0 100644 --- a/doc/user/project/cycle_analytics.md +++ b/doc/user/project/cycle_analytics.md @@ -80,6 +80,7 @@ Here's a little explanation of how this works behind the scenes: To sum up, anything that doesn't follow the [GitLab flow] won't be tracked at all. So, the Cycle Analytics dashboard won't present any data: + - For merge requests that do not close an issue. - For issues not labeled with a label present in the Issue Board. - For issues not assigned a milestone. diff --git a/doc/user/project/import/bitbucket_server.md b/doc/user/project/import/bitbucket_server.md index ebf87890cfd..d51a0c0ccca 100644 --- a/doc/user/project/import/bitbucket_server.md +++ b/doc/user/project/import/bitbucket_server.md @@ -22,14 +22,14 @@ Import your projects from Bitbucket Server to GitLab with minimal effort. ## Limitations 1. Currently GitLab doesn't allow comments on arbitrary lines of code, so any -Bitbucket comments out of bounds will be inserted as comments in the merge -request. + Bitbucket comments out of bounds will be inserted as comments in the merge + request. 1. Bitbucket Server allows multiple levels of threading. GitLab -import will collapse this into one discussion and quote part of the original -comment. + import will collapse this into one discussion and quote part of the original + comment. 1. Declined pull requests have unreachable commits, which prevents the GitLab -importer from generating a proper diff. These pull requests will show up as -empty changes. + importer from generating a proper diff. These pull requests will show up as + empty changes. 1. Attachments in Markdown are currently not imported. 1. Task lists are not imported. 1. Emoji reactions are not imported diff --git a/doc/user/project/import/fogbugz.md b/doc/user/project/import/fogbugz.md index 17222c53675..13409c93929 100644 --- a/doc/user/project/import/fogbugz.md +++ b/doc/user/project/import/fogbugz.md @@ -23,6 +23,6 @@ users to GitLab users.  1. Once the import has finished click the link to take you to the project -dashboard. Follow the directions to push your existing repository. + dashboard. Follow the directions to push your existing repository.  diff --git a/doc/user/project/import/github.md b/doc/user/project/import/github.md index cf99dded5e2..63b90dd76fd 100644 --- a/doc/user/project/import/github.md +++ b/doc/user/project/import/github.md @@ -67,7 +67,7 @@ developer documentation. Before you begin, ensure that any GitHub users who you want to map to GitLab users have either: - A GitLab account that has logged in using the GitHub icon -\- or - + \- or - - A GitLab account with an email address that matches the [public email address](https://help.github.com/articles/setting-your-commit-email-address-on-github/) of the GitHub user User-matching attempts occur in that order, and if a user is not identified either way, the activity is associated with diff --git a/doc/user/project/index.md b/doc/user/project/index.md index 6a1aadf058e..c62de41c539 100644 --- a/doc/user/project/index.md +++ b/doc/user/project/index.md @@ -19,7 +19,7 @@ When you create a project in GitLab, you'll have access to a large number of - [Issue Boards](issue_board.md): Organize and prioritize your workflow - [Multiple Issue Boards](https://docs.gitlab.com/ee/user/project/issue_board.html#multiple-issue-boards): Allow your teams to create their own workflows (Issue Boards) for the same project **[STARTER]** - [Repositories](repository/index.md): Host your code in a fully -integrated platform + integrated platform - [Branches](repository/branches/index.md): use Git branching strategies to collaborate on code - [Protected branches](protected_branches.md): Prevent collaborators @@ -29,7 +29,7 @@ integrated platform - [Signing commits](gpg_signed_commits/index.md): use GPG to sign your commits - [Deploy tokens](deploy_tokens/index.md): Manage project-based deploy tokens that allow permanent access to the repository and Container Registry. - [Merge Requests](merge_requests/index.md): Apply your branching -strategy and get reviewed by your team + strategy and get reviewed by your team - [Merge Request Approvals](https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html): Ask for approval before implementing a change **[STARTER]** - [Fix merge conflicts from the UI](merge_requests/resolve_conflicts.md): @@ -38,13 +38,13 @@ strategy and get reviewed by your team of the changes proposed in a merge request in a per-branch basis - [Labels](labels.md): Organize issues and merge requests by labels - [Time Tracking](../../workflow/time_tracking.md): Track estimate time -and time spent on + and time spent on the conclusion of an issue or merge request - [Milestones](milestones/index.md): Work towards a target date - [Description templates](description_templates.md): Define context-specific -templates for issue and merge request description fields for your project + templates for issue and merge request description fields for your project - [Slash commands (quick actions)](quick_actions.md): Textual shortcuts for -common actions on issues or merge requests + common actions on issues or merge requests - [Web IDE](web_ide/index.md) **GitLab CI/CD:** @@ -68,7 +68,7 @@ common actions on issues or merge requests - [Kubernetes cluster integration](clusters/index.md): Connecting your GitLab project with a Kubernetes cluster - [GitLab Pages](pages/index.md): Build, test, and deploy your static -website with GitLab Pages + website with GitLab Pages **Other features:** @@ -76,11 +76,11 @@ website with GitLab Pages - [Snippets](../snippets.md): store, share and collaborate on code snippets. - [Cycle Analytics](cycle_analytics.md): review your development lifecycle. - [Syntax highlighting](highlighting.md): an alternative to customize -your code blocks, overriding GitLab's default choice of language. + your code blocks, overriding GitLab's default choice of language. - [Badges](badges.md): badges for the project overview. - [Releases](releases/index.md): a way to track deliverables in your project as snapshot in time of -the source, build output, and other metadata or artifacts -associated with a released version of your code. + the source, build output, and other metadata or artifacts + associated with a released version of your code. ### Project's integrations @@ -96,7 +96,7 @@ Learn how to [create a new project](../../gitlab-basics/create-project.md) in Gi You can [fork a project](../../gitlab-basics/fork-project.md) in order to: - Collaborate on code by forking a project and creating a merge request -from your fork to the upstream project + from your fork to the upstream project - Fork a sample project to work on the top of that ## Project settings diff --git a/doc/user/project/integrations/irker.md b/doc/user/project/integrations/irker.md index f220fa8497a..4fb753d1707 100644 --- a/doc/user/project/integrations/irker.md +++ b/doc/user/project/integrations/irker.md @@ -30,12 +30,12 @@ need to follow the firsts steps of the next section. 1. Click "Irker". 1. Select the "Active" checkbox. 1. Enter the server host address where `irkerd` runs (defaults to `localhost`) -in the `Server host` field on the Web page + in the `Server host` field on the Web page 1. Enter the server port of `irkerd` (e.g. defaults to 6659) in the -`Server port` field on the Web page. + `Server port` field on the Web page. 1. Optional: if `Default IRC URI` is set, it has to be in the format -`irc[s]://domain.name` and will be prepend to each and every channel provided -by the user which is not a full URI. + `irc[s]://domain.name` and will be prepend to each and every channel provided + by the user which is not a full URI. 1. Specify the recipients (e.g. #channel1, user1, etc.) 1. Save or optionally click "Test Settings". diff --git a/doc/user/project/integrations/redmine.md b/doc/user/project/integrations/redmine.md index 76a2617125e..8112aa21859 100644 --- a/doc/user/project/integrations/redmine.md +++ b/doc/user/project/integrations/redmine.md @@ -1,9 +1,9 @@ # Redmine Service 1. To enable the Redmine integration in a project, navigate to the -[Integrations page](project_services.md#accessing-the-project-services), click -the **Redmine** service, and fill in the required details on the page as described -in the table below. + [Integrations page](project_services.md#accessing-the-project-services), click + the **Redmine** service, and fill in the required details on the page as described + in the table below. | Field | Description | | ----- | ----------- | diff --git a/doc/user/project/integrations/webhooks.md b/doc/user/project/integrations/webhooks.md index cbf08a4f30a..c3fc6d4b859 100644 --- a/doc/user/project/integrations/webhooks.md +++ b/doc/user/project/integrations/webhooks.md @@ -48,9 +48,9 @@ Navigate to the webhooks page by going to your project's ## Use-cases - You can set up a webhook in GitLab to send a notification to -[Slack](https://api.slack.com/incoming-webhooks) every time a build fails, for example + [Slack](https://api.slack.com/incoming-webhooks) every time a build fails, for example - You can [integrate with Twilio to be notified via SMS](https://www.datadoghq.com/blog/send-alerts-sms-customizable-webhooks-twilio/) -every time an issue is created for a specific project or group within GitLab + every time an issue is created for a specific project or group within GitLab - You can use them to [automatically assign labels to merge requests](https://about.gitlab.com/2016/08/19/applying-gitlab-labels-automatically/). ## Webhook endpoint tips diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index 7962eeada5c..0bd565547c3 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -78,9 +78,9 @@ with labels, and from there organize and prioritize them with Issue Boards. For example, let's consider this simplified development workflow: 1. You have a repository hosting your app's codebase -and your team actively contributing to code + and your team actively contributing to code 1. Your **backend** team starts working a new -implementation, gathers feedback and approval, and pass it over to **frontend** + implementation, gathers feedback and approval, and pass it over to **frontend** 1. When frontend is complete, the new feature is deployed to **staging** to be tested 1. When successful, it is deployed to **production** @@ -88,7 +88,7 @@ If we have the labels "**backend**", "**frontend**", "**staging**", and "**production**", and an Issue Board with a list for each, we can: - Visualize the entire flow of implementations since the -beginning of the development lifecycle until deployed to production + beginning of the development lifecycle until deployed to production - Prioritize the issues in a list by moving them vertically - Move issues between lists to organize them according to the labels you've set - Add multiple issues to lists in the board by selecting one or more existing issues @@ -177,7 +177,7 @@ menu from where you can create another Issue Board and rename or delete the existing one. Using the search box at the top of the menu, you can filter the listed boards. -When you're revisiting an issue board in a project or group with multiple boards, +When you're revisiting an issue board in a project or group with multiple boards, GitLab will automatically load the last board you visited. NOTE: **Note:** @@ -234,7 +234,7 @@ group-level objects are available. NOTE: **Note:** Multiple group issue boards were originally introduced in [GitLab 10.0 Premium](https://about.gitlab.com/2017/09/22/gitlab-10-0-released/#group-issue-boards) and -one group issue board per group was made available in GitLab 10.6 Core. +one group issue board per group was made available in GitLab 10.6 Core.  diff --git a/doc/user/project/issues/automatic_issue_closing.md b/doc/user/project/issues/automatic_issue_closing.md index afb7d9ada5f..c3e06b219ff 100644 --- a/doc/user/project/issues/automatic_issue_closing.md +++ b/doc/user/project/issues/automatic_issue_closing.md @@ -1,6 +1,7 @@ # Automatic issue closing >**Notes:** +> > - This is the user docs. In order to change the default issue closing pattern, > follow the steps in the [administration docs]. > - For performance reasons, automatic issue closing is disabled for the very diff --git a/doc/user/project/issues/create_new_issue.md b/doc/user/project/issues/create_new_issue.md index 2bf4fa287e9..40040e44d64 100644 --- a/doc/user/project/issues/create_new_issue.md +++ b/doc/user/project/issues/create_new_issue.md @@ -79,6 +79,6 @@ in the same URL (since a description template just populates the description fie Follow these examples to form your new issue URL with prefilled fields. - For a new issue in the GitLab Community Edition project with a pre-entered title -and a pre-entered description, the URL would be `https://gitlab.com/gitlab-org/gitlab-ce/issues/new?issue[title]=Validate%20new%20concept&issue[description]=Research%20idea` + and a pre-entered description, the URL would be `https://gitlab.com/gitlab-org/gitlab-ce/issues/new?issue[title]=Validate%20new%20concept&issue[description]=Research%20idea` - For a new issue in the GitLab Community Edition project with a pre-entered title -and a pre-entered description template, the URL would be `https://gitlab.com/gitlab-org/gitlab-ce/issues/new?issue[title]=Validate%20new%20concept&issuable_template=Research%20proposal` + and a pre-entered description template, the URL would be `https://gitlab.com/gitlab-org/gitlab-ce/issues/new?issue[title]=Validate%20new%20concept&issuable_template=Research%20proposal` diff --git a/doc/user/project/issues/due_dates.md b/doc/user/project/issues/due_dates.md index 93306437c6c..7972c14c1c4 100644 --- a/doc/user/project/issues/due_dates.md +++ b/doc/user/project/issues/due_dates.md @@ -42,6 +42,7 @@ server's timezone. Issues with due dates can also be exported as an iCalendar feed. The URL of the feed can be added to calendar applications. The feed is accessible by clicking on the _Subscribe to calendar_ button on the following pages: + - on the **Assigned Issues** page that is linked on the right-hand side of the GitLab header - on the **Project Issues** page diff --git a/doc/user/project/issues/issues_functionalities.md b/doc/user/project/issues/issues_functionalities.md index e4a3ff52e07..27b9dc51760 100644 --- a/doc/user/project/issues/issues_functionalities.md +++ b/doc/user/project/issues/issues_functionalities.md @@ -99,16 +99,16 @@ Learn more in the [Issue Weight documentation](https://docs.gitlab.com/ee/workfl #### 10. Notifications - Subscribe: if you are not a participant of the discussion on that issue, but -want to receive notifications on each new input, subscribe to it. + want to receive notifications on each new input, subscribe to it. - Unsubscribe: if you are receiving notifications on that issue but no -longer want to receive them, unsubscribe from it. + longer want to receive them, unsubscribe from it. Read more in the [notifications documentation](../../../workflow/notifications.md#issue--merge-request-events). #### 11. Reference - A quick "copy to clipboard" button for that issue's reference, `foo/bar#xxx`, where `foo` is the `username` or `groupname`, `bar` -is the `project-name`, and `xxx` is the issue number. + is the `project-name`, and `xxx` is the issue number. #### 12. Title and description @@ -138,7 +138,7 @@ interpreted as spam. #### 14. Related Merge Requests - Any merge requests mentioned in that issue's description -or in the issue discussion thread. + or in the issue discussion thread. #### 15. Award emoji @@ -152,8 +152,8 @@ know you like it without spamming them. #### 16. Thread - Comments: collaborate to that issue by posting comments in its thread. -These text fields also fully support -[GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm). + These text fields also fully support + [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm). #### 17. Comment, start a discussion, or comment and close @@ -166,7 +166,7 @@ Once you write a comment, you can either: #### 18. New Merge Request - Create a new merge request (with a new source branch named after the issue) in one action. -The merge request will automatically inherit the milestone and labels of the issue. The merge -request will automatically close that issue when it is merged. + The merge request will automatically inherit the milestone and labels of the issue. The merge + request will automatically close that issue when it is merged. - Optionally, you can just create a [new branch](../repository/web_editor.md#create-a-new-branch-from-an-issue) -named after that issue. + named after that issue. diff --git a/doc/user/project/operations/error_tracking.md b/doc/user/project/operations/error_tracking.md index 90bb92d2062..41aa5b91aa7 100644 --- a/doc/user/project/operations/error_tracking.md +++ b/doc/user/project/operations/error_tracking.md @@ -21,7 +21,7 @@ GitLab provides an easy way to connect Sentry to your project: 1. Sign up to Sentry.io or [deploy your own](#deploying-sentry) Sentry instance. 1. [Find or generate](https://docs.sentry.io/api/auth/) a Sentry auth token for your Sentry project. -Make sure to give the token at least the following scopes: `event:read` and `project:read`. + Make sure to give the token at least the following scopes: `event:read` and `project:read`. 1. Navigate to your project’s **Settings > Operations** and provide the Sentry API URL and auth token. 1. Ensure that the 'Active' checkbox is set. 1. Click **Save changes** for the changes to take effect. diff --git a/doc/user/project/pages/getting_started_part_four.md b/doc/user/project/pages/getting_started_part_four.md index e4ee2f7cdfa..05d5a2fd99a 100644 --- a/doc/user/project/pages/getting_started_part_four.md +++ b/doc/user/project/pages/getting_started_part_four.md @@ -376,11 +376,11 @@ manually in the past. Read through the to understand how to go even further on your scripts. - On this blog post, understand the concept of -[using GitLab CI `environments` to deploy your -web app to staging and production](https://about.gitlab.com/2016/08/26/ci-deployment-and-environments/). + [using GitLab CI `environments` to deploy your + web app to staging and production](https://about.gitlab.com/2016/08/26/ci-deployment-and-environments/). - On this post, learn [how to run jobs sequentially, -in parallel, or build a custom pipeline](https://about.gitlab.com/2016/07/29/the-basics-of-gitlab-ci/) + in parallel, or build a custom pipeline](https://about.gitlab.com/2016/07/29/the-basics-of-gitlab-ci/) - On this blog post, we go through the process of -[pulling specific directories from different projects](https://about.gitlab.com/2016/12/07/building-a-new-gitlab-docs-site-with-nanoc-gitlab-ci-and-gitlab-pages/) -to deploy this website you're looking at, docs.gitlab.com. + [pulling specific directories from different projects](https://about.gitlab.com/2016/12/07/building-a-new-gitlab-docs-site-with-nanoc-gitlab-ci-and-gitlab-pages/) + to deploy this website you're looking at, docs.gitlab.com. - On this blog post, we teach you [how to use GitLab Pages to produce a code coverage report](https://about.gitlab.com/2016/11/03/publish-code-coverage-report-with-gitlab-pages/). diff --git a/doc/user/project/pages/getting_started_part_one.md b/doc/user/project/pages/getting_started_part_one.md index 595241b2cba..9a95fb70964 100644 --- a/doc/user/project/pages/getting_started_part_one.md +++ b/doc/user/project/pages/getting_started_part_one.md @@ -77,41 +77,41 @@ Learn more about [namespaces](../../group/index.md#namespaces). #### Project Websites - You created a project called `blog` under your username `john`, -therefore your project URL is `https://gitlab.com/john/blog/`. -Once you enable GitLab Pages for this project, and build your site, -it will be available under `https://john.gitlab.io/blog/`. + therefore your project URL is `https://gitlab.com/john/blog/`. + Once you enable GitLab Pages for this project, and build your site, + it will be available under `https://john.gitlab.io/blog/`. - You created a group for all your websites called `websites`, -and a project within this group is called `blog`. Your project -URL is `https://gitlab.com/websites/blog/`. Once you enable -GitLab Pages for this project, the site will live under -`https://websites.gitlab.io/blog/`. + and a project within this group is called `blog`. Your project + URL is `https://gitlab.com/websites/blog/`. Once you enable + GitLab Pages for this project, the site will live under + `https://websites.gitlab.io/blog/`. - You created a group for your engineering department called `engineering`, -a subgroup for all your documentation websites called `docs`, -and a project within this subgroup is called `workflows`. Your project -URL is `https://gitlab.com/engineering/docs/workflows/`. Once you enable -GitLab Pages for this project, the site will live under -`https://engineering.gitlab.io/docs/workflows`. + a subgroup for all your documentation websites called `docs`, + and a project within this subgroup is called `workflows`. Your project + URL is `https://gitlab.com/engineering/docs/workflows/`. Once you enable + GitLab Pages for this project, the site will live under + `https://engineering.gitlab.io/docs/workflows`. #### User and Group Websites - Under your username, `john`, you created a project called -`john.gitlab.io`. Your project URL will be `https://gitlab.com/john/john.gitlab.io`. -Once you enable GitLab Pages for your project, your website -will be published under `https://john.gitlab.io`. + `john.gitlab.io`. Your project URL will be `https://gitlab.com/john/john.gitlab.io`. + Once you enable GitLab Pages for your project, your website + will be published under `https://john.gitlab.io`. - Under your group `websites`, you created a project called -`websites.gitlab.io`. your project's URL will be `https://gitlab.com/websites/websites.gitlab.io`. -Once you enable GitLab Pages for your project, -your website will be published under `https://websites.gitlab.io`. + `websites.gitlab.io`. your project's URL will be `https://gitlab.com/websites/websites.gitlab.io`. + Once you enable GitLab Pages for your project, + your website will be published under `https://websites.gitlab.io`. > Support for subgroup project's websites was [introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/30548) in GitLab 11.8. **General example:** - On GitLab.com, a project site will always be available under -`https://namespace.gitlab.io/project-name` + `https://namespace.gitlab.io/project-name` - On GitLab.com, a user or group website will be available under -`https://namespace.gitlab.io/` + `https://namespace.gitlab.io/` - On your GitLab instance, replace `gitlab.io` above with your -Pages server domain. Ask your sysadmin for this information. + Pages server domain. Ask your sysadmin for this information. _Read on about [Projects for GitLab Pages and URL structure](getting_started_part_two.md)._ diff --git a/doc/user/project/pages/getting_started_part_three.md b/doc/user/project/pages/getting_started_part_three.md index b2da1c85c62..daae2f4b5a3 100644 --- a/doc/user/project/pages/getting_started_part_three.md +++ b/doc/user/project/pages/getting_started_part_three.md @@ -19,7 +19,7 @@ To use one or more custom domain with your Pages site, there are two things you should consider first, which we'll cover in this guide: 1. Either if you're adding a **root domain** or a **subdomain**, for which -you'll need to set up [DNS records](#dns-records) + you'll need to set up [DNS records](#dns-records) 1. Whether you want to add an [SSL/TLS certificate](#ssl-tls-certificates) or not To finish the association, you need to [add your domain to your project's Pages settings](#add-your-custom-domain-to-gitlab-pages-settings). @@ -136,13 +136,13 @@ verify your domain's ownership with a TXT record: > **Notes**: > > - **Do not** use a CNAME record if you want to point your -`domain.com` to your GitLab Pages site. Use an `A` record instead. + `domain.com` to your GitLab Pages site. Use an `A` record instead. > - **Do not** add any special chars after the default Pages -domain. E.g., **do not** point your `subdomain.domain.com` to -`namespace.gitlab.io.` or `namespace.gitlab.io/`. + domain. E.g., **do not** point your `subdomain.domain.com` to + `namespace.gitlab.io.` or `namespace.gitlab.io/`. > - GitLab Pages IP on GitLab.com [was changed](https://about.gitlab.com/2017/03/06/we-are-changing-the-ip-of-gitlab-pages-on-gitlab-com/) in 2017 > - GitLab Pages IP on GitLab.com [has been changed](https://about.gitlab.com/2018/07/19/gcp-move-update/#gitlab-pages-and-custom-domains) -from `52.167.214.135` to `35.185.44.232` in 2018 + from `52.167.214.135` to `35.185.44.232` in 2018 ### Add your custom domain to GitLab Pages settings @@ -278,15 +278,15 @@ These fields are found under your **Project**'s **Settings** > **Pages** > **New ### What's what? - A PEM certificate is the certificate generated by the CA, -which needs to be added to the field **Certificate (PEM)**. + which needs to be added to the field **Certificate (PEM)**. - An [intermediate certificate](https://en.wikipedia.org/wiki/Intermediate_certificate_authority) (aka "root certificate") is -the part of the encryption keychain that identifies the CA. -Usually it's combined with the PEM certificate, but there are -some cases in which you need to add them manually. -[CloudFlare certs](https://about.gitlab.com/2017/02/07/setting-up-gitlab-pages-with-cloudflare-certificates/) -are one of these cases. + the part of the encryption keychain that identifies the CA. + Usually it's combined with the PEM certificate, but there are + some cases in which you need to add them manually. + [CloudFlare certs](https://about.gitlab.com/2017/02/07/setting-up-gitlab-pages-with-cloudflare-certificates/) + are one of these cases. - A private key is an encrypted key which validates -your PEM against your domain. + your PEM against your domain. ### Now what? @@ -295,9 +295,9 @@ of this, it's simple: - Your PEM certificate needs to be added to the first field - If your certificate is missing its intermediate, copy -and paste the root certificate (usually available from your CA website) -and paste it in the [same field as your PEM certificate](https://about.gitlab.com/2017/02/07/setting-up-gitlab-pages-with-cloudflare-certificates/), -just jumping a line between them. + and paste the root certificate (usually available from your CA website) + and paste it in the [same field as your PEM certificate](https://about.gitlab.com/2017/02/07/setting-up-gitlab-pages-with-cloudflare-certificates/), + just jumping a line between them. - Copy your private key and paste it in the last field >**Note:** diff --git a/doc/user/project/pages/getting_started_part_two.md b/doc/user/project/pages/getting_started_part_two.md index c9081a6d72b..644a1c951d3 100644 --- a/doc/user/project/pages/getting_started_part_two.md +++ b/doc/user/project/pages/getting_started_part_two.md @@ -16,7 +16,7 @@ To get started with GitLab Pages, you need: 1. A project 1. A configuration file (`.gitlab-ci.yml`) to deploy your site 1. A specific `job` called `pages` in the configuration file -that will make GitLab aware that you are deploying a GitLab Pages website + that will make GitLab aware that you are deploying a GitLab Pages website 1. A `public` directory with the content of the website Optional Features: @@ -85,16 +85,16 @@ is useful for submitting merge requests to the upstream. ### Create a project from scratch 1. From your **Project**'s **[Dashboard](https://gitlab.com/dashboard/projects)**, -click **New project**, and name it considering the -[practical examples](getting_started_part_one.md#practical-examples). + click **New project**, and name it considering the + [practical examples](getting_started_part_one.md#practical-examples). 1. Clone it to your local computer, add your website -files to your project, add, commit and push to GitLab. + files to your project, add, commit and push to GitLab. 1. From the your **Project**'s page, click **Set up CI/CD**:  1. Choose one of the templates from the dropbox menu. -Pick up the template corresponding to the SSG you're using (or plain HTML). + Pick up the template corresponding to the SSG you're using (or plain HTML).  @@ -107,20 +107,20 @@ where you'll find its default URL. > **Notes:** > > - GitLab Pages [supports any SSG](https://about.gitlab.com/2016/06/17/ssg-overview-gitlab-pages-part-3-examples-ci/), but, -if you don't find yours among the templates, you'll need -to configure your own `.gitlab-ci.yml`. To do that, please -read through the article [Creating and Tweaking GitLab CI/CD for GitLab Pages](getting_started_part_four.md). New SSGs are very welcome among -the [example projects](https://gitlab.com/pages). If you set -up a new one, please -[contribute](https://gitlab.com/pages/pages.gitlab.io/blob/master/CONTRIBUTING.md) -to our examples. + if you don't find yours among the templates, you'll need + to configure your own `.gitlab-ci.yml`. To do that, please + read through the article [Creating and Tweaking GitLab CI/CD for GitLab Pages](getting_started_part_four.md). New SSGs are very welcome among + the [example projects](https://gitlab.com/pages). If you set + up a new one, please + [contribute](https://gitlab.com/pages/pages.gitlab.io/blob/master/CONTRIBUTING.md) + to our examples. > > - The second step _"Clone it to your local computer"_, can be done -differently, achieving the same results: instead of cloning the bare -repository to you local computer and moving your site files into it, -you can run `git init` in your local website directory, add the -remote URL: `git remote add origin git@gitlab.com:namespace/project-name.git`, -then add, commit, and push. + differently, achieving the same results: instead of cloning the bare + repository to you local computer and moving your site files into it, + you can run `git init` in your local website directory, add the + remote URL: `git remote add origin git@gitlab.com:namespace/project-name.git`, + then add, commit, and push. ## URLs and Baseurls diff --git a/doc/user/project/pages/index.md b/doc/user/project/pages/index.md index 2de3fb7e080..e0b78753e21 100644 --- a/doc/user/project/pages/index.md +++ b/doc/user/project/pages/index.md @@ -91,13 +91,13 @@ site under the HTTPS protocol. ## Getting started -To get started with GitLab Pages, you can either [create a project from scratch](getting_started_part_two.md#create-a-project-from-scratch), +To get started with GitLab Pages, you can either [create a project from scratch](getting_started_part_two.md#create-a-project-from-scratch), use a [bundled template](getting_started_part_two.md#use-one-of-the-popular-pages-templates-bundled-with-gitlab), or copy any of our existing example projects: 1. Choose an [example project](https://gitlab.com/pages) to [fork](../../../gitlab-basics/fork-project.md#how-to-fork-a-project): by forking a project, you create a copy of the codebase you're forking from to start from a template instead of starting from scratch. 1. From the left sidebar, navigate to your project's **CI/CD > Pipelines** and click -**Run pipeline** so that GitLab CI/CD will build and deploy your site to the server. + **Run pipeline** so that GitLab CI/CD will build and deploy your site to the server. 1. Once the pipeline has finished successfully, find the link to visit your website from your project's **Settings > Pages**. @@ -164,7 +164,7 @@ with Pages, read through this series: ### GitLab Pages with SSL/TLS certificates -If you're using GitLab Pages default domain (`.gitlab.io`), your website will be +If you're using GitLab Pages default domain (`.gitlab.io`), your website will be automatically secure and available under HTTPS. If you're using your own domain, you can optionally secure it with SSL/TLS certificates. You can read the following tutorials to learn how to use these third-party certificates with GitLab Pages: diff --git a/doc/user/project/repository/index.md b/doc/user/project/repository/index.md index fac5975a0dc..22d912cd9d1 100644 --- a/doc/user/project/repository/index.md +++ b/doc/user/project/repository/index.md @@ -146,9 +146,9 @@ you are introducing those changes to your branch. Via command line, you can commit multiple times before pushing. - **Commit message:** -A commit message is important to identity what is being changed and, -more importantly, why. In GitLab, you can add keywords to the commit -message that will perform one of the actions below: + A commit message is important to identity what is being changed and, + more importantly, why. In GitLab, you can add keywords to the commit + message that will perform one of the actions below: - **Trigger a GitLab CI/CD pipeline:** If you have your project configured with [GitLab CI/CD](../../../ci/README.md), you will trigger a pipeline per push, not per commit. @@ -162,14 +162,14 @@ message that will perform one of the actions below: If you mention an issue or a merge request in a commit message, they will be shown on their respective thread. - **Cherry-pick a commit:** -In GitLab, you can -[cherry-pick a commit](../merge_requests/cherry_pick_changes.md#cherry-picking-a-commit) -right from the UI. + In GitLab, you can + [cherry-pick a commit](../merge_requests/cherry_pick_changes.md#cherry-picking-a-commit) + right from the UI. - **Revert a commit:** -Easily [revert a commit](../merge_requests/revert_changes.md#reverting-a-commit) -from the UI to a selected branch. + Easily [revert a commit](../merge_requests/revert_changes.md#reverting-a-commit) + from the UI to a selected branch. - **Sign a commit:** -Use GPG to [sign your commits](gpg_signed_commits/index.md). + Use GPG to [sign your commits](gpg_signed_commits/index.md). ## Repository size diff --git a/doc/user/project/web_ide/index.md b/doc/user/project/web_ide/index.md index 3e85e97d7a5..46a1b2bc3aa 100644 --- a/doc/user/project/web_ide/index.md +++ b/doc/user/project/web_ide/index.md @@ -24,21 +24,21 @@ file path fragments to start seeing results. ## Syntax highlighting -As expected from an IDE, syntax highlighting for many languages within +As expected from an IDE, syntax highlighting for many languages within the Web IDE will make your direct editing even easier. The Web IDE currently provides: -- Basic syntax colorization for a variety of programming, scripting and markup -languages such as XML, PHP, C#, C++, Markdown, Java, VB, Batch, Python, Ruby -and Objective-C. -- IntelliSense and validation support (displaying errors and warnings, providing -smart completions, formatting, and outlining) for some languages. For example: -TypeScript, JavaScript, CSS, LESS, SCSS, JSON and HTML. +- Basic syntax colorization for a variety of programming, scripting and markup + languages such as XML, PHP, C#, C++, Markdown, Java, VB, Batch, Python, Ruby + and Objective-C. +- IntelliSense and validation support (displaying errors and warnings, providing + smart completions, formatting, and outlining) for some languages. For example: +TypeScript, JavaScript, CSS, LESS, SCSS, JSON and HTML. -Because the Web IDE is based on the [Monaco Editor](https://microsoft.github.io/monaco-editor/), -you can find a more complete list of supported languages in the -[Monaco languages](https://github.com/Microsoft/monaco-languages) repository. +Because the Web IDE is based on the [Monaco Editor](https://microsoft.github.io/monaco-editor/), +you can find a more complete list of supported languages in the +[Monaco languages](https://github.com/Microsoft/monaco-languages) repository. NOTE: **Note:** Single file editing is based on the [Ace Editor](https://ace.c9.io). diff --git a/doc/user/reserved_names.md b/doc/user/reserved_names.md index a14df6c8402..9aa81e33fc0 100644 --- a/doc/user/reserved_names.md +++ b/doc/user/reserved_names.md @@ -5,6 +5,7 @@ existing routes used by GitLab. For a list of words that are not allowed to be used as group or project names, see the [`path_regex.rb` file][reserved] under the `TOP_LEVEL_ROUTES`, `PROJECT_WILDCARD_ROUTES` and `GROUP_ROUTES` lists: + - `TOP_LEVEL_ROUTES`: are names that are reserved as usernames or top level groups - `PROJECT_WILDCARD_ROUTES`: are names that are reserved for child groups or projects. - `GROUP_ROUTES`: are names that are reserved for all groups or projects. |