diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-11-23 14:57:46 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-11-23 14:57:46 +0000 |
commit | 64fc6a9b19faca58ad0087b1a1cb11f7ed910015 (patch) | |
tree | fe4e98cfab4289850ee15965ae0b04648ee90207 /doc/user/project | |
parent | 6317794da29af0bccf95dece5b57b2be2c0977a4 (diff) | |
download | gitlab-ce-64fc6a9b19faca58ad0087b1a1cb11f7ed910015.tar.gz |
Add latest changes from gitlab-org/gitlab@13-6-stable-ee
Diffstat (limited to 'doc/user/project')
-rw-r--r-- | doc/user/project/issue_board.md | 40 | ||||
-rw-r--r-- | doc/user/project/static_site_editor/index.md | 43 |
2 files changed, 71 insertions, 12 deletions
diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index dfe608df18d..116602fbbb9 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -366,7 +366,7 @@ status. ## Actions you can take on an issue board - [Create a new list](#create-a-new-list). -- [Delete an existing list](#delete-a-list). +- [Remove an existing list](#remove-a-list). - [Add issues to a list](#add-issues-to-a-list). - [Remove an issue from a list](#remove-an-issue-from-a-list). - [Filter issues](#filter-issues) that appear across your issue board. @@ -407,23 +407,36 @@ choosing **Create project label** or **Create group label**. This creates the label immediately and adds it to the dropdown. You can now choose it to create a list. -### Delete a list +### Remove a list -To delete a list from the issue board, use the small trash icon present -in the list's heading. A confirmation dialog appears for you to confirm. - -Deleting a list doesn't have any effect on issues and labels, as it's just the +Removing a list doesn't have any effect on issues and labels, as it's just the list view that's removed. You can always restore it later if you need. +To remove a list from an issue board: + +1. Select the **List settings** icon (**{settings}**) on the top of the list you want to remove. The + list settings sidebar opens on the right. +1. Select **Remove list**. A confirmation dialog appears. +1. Select **OK**. + ### Add issues to a list -You can add issues to a list by clicking the **Add issues** button +You can add issues to a list in a project issue board by clicking the **Add issues** button in the top right corner of the issue board. This opens up a modal window where you can see all the issues that do not belong to any list. Select one or more issues by clicking the cards and then click **Add issues** to add them to the selected list. You can limit the issues you want to add to -the list by filtering by author, assignee, milestone, and label. +the list by filtering by the following: + +- Assignee +- Author +- Epic +- Label +- Milestone +- My Reaction +- Release +- Weight ![Bulk adding issues to lists](img/issue_boards_add_issues_modal_v13_6.png) @@ -441,7 +454,16 @@ You should be able to use the filters on top of your issue board to show only the results you want. It's similar to the filtering used in the issue tracker, as the metadata from the issues and labels is re-used in the issue board. -You can filter by author, assignee, milestone, and label. +You can filter by the following: + +- Assignee +- Author +- Epic +- Label +- Milestone +- My Reaction +- Release +- Weight ### Create workflows diff --git a/doc/user/project/static_site_editor/index.md b/doc/user/project/static_site_editor/index.md index e58667c275c..c2d4c77a469 100644 --- a/doc/user/project/static_site_editor/index.md +++ b/doc/user/project/static_site_editor/index.md @@ -66,10 +66,12 @@ easily [edit your content](#edit-content). 1. To get started, create a new project from the [Static Site Editor - Middleman](https://gitlab.com/gitlab-org/project-templates/static-site-editor-middleman) template. You can either [fork it](../repository/forking_workflow.md#creating-a-fork) or [create a new project from a template](../../../gitlab-basics/create-project.md#built-in-templates). -1. Edit the [`data/config.yml`](#configuration-files) configuration file +1. Edit the [`data/config.yml`](#static-site-generator-configuration) configuration file to replace `<username>` and `<project-name>` with the proper values for - your project's path. This triggers a CI/CD pipeline to deploy your project - with GitLab Pages. + your project's path. +1. (Optional) Edit the [`.gitlab/static-site-editor.yml`](#static-site-editor-configuration-file) file + to customize the behavior of the Static Site Editor. +1. When you submit your changes, GitLab triggers a CI/CD pipeline to deploy your project with GitLab Pages. 1. When the pipeline finishes, from your project's left-side menu, go to **Settings > Pages** to find the URL of your new website. 1. Visit your website and look at the bottom-left corner of the screen to see the new **Edit this page** button. @@ -179,6 +181,41 @@ yet. You can do so by editing the file locally, through the GitLab regular file ## Configuration files +You can customize the behavior of a project which uses the Static Site Editor with +the following configuration files: + +- The [`.gitlab/static-site-editor.yml`](#static-site-editor-configuration-file), which customizes the + behavior of the Static Site Editor. +- [Static Site Generator configuration files](#static-site-generator-configuration), + such as `data/config.yml`, which configures the Static Site Generator itself. + It also controls the **Edit this page** button when the site is generated. + +### Static Site Editor configuration file + +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4267) in GitLab 13.6. + +The `.gitlab/static-site-editor.yml` configuration file contains entries you can +use to customize behavior of the Static Site Editor (SSE). If the file does not exist, +default values which support a default Middleman project configuration are used. +The [Static Site Editor - Middleman](https://gitlab.com/gitlab-org/project-templates/static-site-editor-middleman) project template generates a file pre-populated with these defaults. + +To customize the behavior of the SSE, edit `.gitlab/static-site-editor.yml`'s entries +(described in the table below) according to what works best for your project (respecting YAML syntax). + +After the table, see an [example of the SSE configuration file](#gitlabstatic-site-editoryml-example). + +| Entry | GitLab version | Type | Default value | Description | +|---|---|---|---|---| +| `image_upload_path` | [13.6](https://gitlab.com/gitlab-org/gitlab/-/issues/216641) | String | `source/images` | Directory for images uploaded from the WYSIWYG editor. | + +#### `.gitlab/static-site-editor.yml` example + +```yaml +image_upload_path: 'source/images' # Relative path to the project's root. Don't include leading or trailing slashes. +``` + +### Static Site Generator configuration + The Static Site Editor uses Middleman's configuration file, `data/config.yml` to customize the behavior of the project itself and to control the **Edit this page** button, rendered through the file [`layout.erb`](https://gitlab.com/gitlab-org/project-templates/static-site-editor-middleman/-/blob/master/source/layouts/layout.erb). |