5a3f418e13
* Docs: write down the currently available steps * docs: quick updates to the projects page. * docs: further scaffold the how-to guide * docs: add feature-toggle.mdx (toggle reference doc) * docs: Add note that feature toggle names must be unique * docs: add API doc links * docs: delete old content * docs: delete old images * docs: update variants text * docs: update introduction * docs: add new images, update api annotations * docs: add links to context fields, improve link text for other links. * docs: remove redundant wording. * docs: fix default project for toggles * docs: typo: singular -> plural * docs: mention admin ui curl command * docs: remove leftover words * docs: improve linking to default project. * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * Apply suggestions from code review Co-authored-by: sighphyre <liquidwicked64@gmail.com> * docs: clarify constraint timing * docs: apply suggestion from code review * docs: add link to variants document * docs: Add sections on environments and projects, link from ft docs * docs: minor rewording into unleash context. * docs: remove misleading section about "all strats evaluated" * docs: evaluate -> resolve Co-authored-by: sighphyre <liquidwicked64@gmail.com>
5.6 KiB
| id | title |
|---|---|
| projects | Projects |
:::info feature availability
All users get access to projects, but only pro and enterprise users can create, update, or delete them.
:::
This document explains how Unleash uses projects, including how to create and maintain them.
The default project
All users get access to the default project. You cannot delete this project. You can, however, rename it if you're using the pro or enterprise version of Unleash.
Understanding purpose of projects
Projects are a way to organize your feature toggles within Unleash. Within a large organization, having multiple feature toggles, staying on top of the feature toggles might become a challenge. Every feature toggle will be part of a project. Projects can be linked to a development team or to functional modules within the software.
A common pattern is to organize the feature toggles according to key areas of the application, e.g. “Basic user process” and “Advanced user process”. This is illustrated below.
Projects and environments
You can configure which environments should be available within a project. By default, all globally available environments are available. You can only enable/disable a feature toggle for the environments you configure for a project.
Within the admin UI, the projects are available under the "environments" tab of the project page. Changing them requires the project owner role.
Creating a new project
When you log into Unleash for the first time, there is a Default project already created. All feature toggles are included in the Default project, unless explicitly set to a different one.
From the top-line menu – click on “Projects”
The available projects will now be listed. To create a new Project – choose the “Add new project”
The configuration of a new Project is now available. the following input is available to create the new Project.
| Item | Description |
|---|---|
| Project Id | Id for this Project |
| Project name | The name of the Project. |
| Description | A short description of the project |
Deleting an existing project
To keep your feature toggles clean, removing deprecated projects is important. From the overview of Projects –
- In the top right of the project card, find the project menu represented by three vertical dots.
- Click on Delete Project
Filter feature toggles on projects
When browsing the feature toggles in Unleash, you might want to filter the view by looking only at the ones included in the project of interest. This is possible from the Feature toggle overview.
From the UI top navigation menu, choose "Feature toggles".
The list of features toggles can be filtered on the project of your choice. By default, all feature toggles are listed in the view.
From the drop-down, chose the project to filter on.
The view will now be updated with the filtered feature toggles.
Assigning project to a new feature toggle
When you create a new feature toggle, you can choose which project to create it in. The default project is whatever project you are currently configuring.
All available projects are available from the drop-down menu.
Change project for an existing feature toggle
If you want to change which project a feature toggle belongs to, you can change that from the feature toggle's configuration page. Under the settings tab, choose the project option and choose the new project from the dropdown menu.
