diff options
Diffstat (limited to 'doc/user/group/epics/epic_boards.md')
| -rw-r--r-- | doc/user/group/epics/epic_boards.md | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/user/group/epics/epic_boards.md b/doc/user/group/epics/epic_boards.md new file mode 100644 index 00000000000..343f7c496b1 --- /dev/null +++ b/doc/user/group/epics/epic_boards.md @@ -0,0 +1,68 @@ +--- +stage: Plan +group: Product Planning +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 +--- + +# Epic Boards **(PREMIUM)** + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2864) in GitLab 13.10. +> - It's [deployed behind a feature flag](../../feature_flags.md), disabled by default. +> - It's disabled on GitLab.com. +> - It's not recommended for production use. +> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](../../../administration/feature_flags.md). + +WARNING: +This feature might not be available to you. Check the **version history** note above for details. + +The GitLab Epic Board is a software project management tool used to plan, +organize, and visualize a workflow for a feature or product release. + +Epic boards build on the existing [epic tracking functionality](index.md) and +[labels](../../project/labels.md). Your epics appear as cards in vertical lists, organized by their assigned +labels. + +To view an epic board, in a group, select **Epics > Boards**. + + + +## Create an epic board + +To create a new epic board: + +1. Select the dropdown with the current board name in the upper left corner of the Epic Boards page. +1. Select **Create new board**. +1. Enter the new board's name and select **Create**. + +## Limitations of epic boards + +As of GitLab 13.10, these limitations apply: + +- Epic Boards need to be enabled by an administrator. +- Epic Boards can be created but not deleted. +- Lists can be added to the board but not deleted. +- There is no sidebar on the board. To edit an epic, go to the epic's page. +- There is no drag and drop support yet. To move an epic between lists, edit epic labels on the epic's page. +- Epics cannot be re-ordered within the list. + +To learn more about the future iterations of this feature, visit +[epic 5067](https://gitlab.com/groups/gitlab-org/-/epics/5067). + +## Enable or disable Epic Boards + +Epic Boards are under development and not ready for production use. It is +deployed behind a feature flag that is **disabled by default**. +[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) +can enable it. + +To enable it: + +```ruby +Feature.enable(:epic_boards) +``` + +To disable it: + +```ruby +Feature.disable(:epic_boards) +``` |