Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-04-10 01:16:39 +02:00
Code Issues Projects Releases Wiki Activity

docs(4.3): update text (and add alt text) in projects document.

Browse Source
This commit is contained in:
Thomas Heartman 2021-12-14 13:47:47 +01:00
parent 23d06264a1
commit 18da69ede0
1 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
website/docs/user_guide/projects.md
View File

@ -17,7 +17,7 @@ Projects are a way to organize your feature toggles within Unleash. Within a lar
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.
![Project concept](/img/project_concept.png)
![A diagram with two boxes labeled \"Basic user process\" and \"Advanced user process\", respectively. The former contains features \"New login\" and \"Winter theme enablement\", the latter \"New in-app purchase\" and \"Updated invoice repository\".](/img/project_concept.png)
## Creating a new project {#creating-a-new-project}
@ -25,15 +25,15 @@ When you log into Unleash for the first time, there is a Default project already
From the top-line menu – click on “Projects”
![Project concept](/img/projects_button.png)
![The Unleash admin UI with the \"Projects\" nav link in the top bar highlighted.](/img/projects_button.png)
The available projects will now be listed. To create a new Project – choose the “Add new project”
![Project concept](/img/projects_new_project.png)
![A list of projects. There is a button saying \"Add new project\".](/img/projects_new_project.png)
The configuration of a new Project is now available. the following input is available to create the new Project.
![Project concept](/img/projects_save_new_project.png)
![A project creation form. The form fields are labeled \"project ID\", \"name\", and \"description\". The "Create" button is highlighted.](/img/projects_save_new_project.png)
| Item | Description |
| ------------ | ---------------------------------- |
@ -43,48 +43,46 @@ The configuration of a new Project is now available. the following input is avai
## Deleting an existing project {#deleting-an-existing-project}
To keep your feature toggles clean, removing deprecated projects is important. From the overview of Projects –
To keep your feature toggles clean, removing deprecated projects is important. From the overview of Projects –
1. In the top right of the project card, find the project menu represented by three vertical dots.
![Project concept](/img/projects_menu_button.png)
![A list of projects. Each project has three vertical dots — a kebab-menu — next to it.](/img/projects_menu_button.png)
2. Click on Delete Project
![Project concept](/img/projects_delete_button.png)
![A list of projects. Each project has three vertical dots — a kebab-menu — next to it, which exposes a menu with the \"Edit project\" and \"Delete project\" options when interacted with.](/img/projects_delete_button.png)
## Filter feature toggles on projects {#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 top-line menu – choose the hamburger icon
From the UI top navigation menu, choose "Feature toggles".
![Project concept](/img/projects_menu.png)
![The Unleash Admin UI navigation menu with the \"Feature toggles\" option highlighted by a red arrow.](/img/projects_menu.png)
The list of features toggles can be filtered on the project of your choice. By default, all feature toggles are listed in the view.
![Project concept](/img/project_select.png)
![The feature toggle list with toggles scoped to the \"fintech\" project. The filter is activated by using a form control.](/img/project_select.png)
From the drop-down, chose the project to filter on.
![Project concept](/img/projects_select_dropdown.png)
![The feature toggle list with an overlay listing all the projects available. You can select a project and the list will update with the toggles belonging to that project.](/img/projects_select_dropdown.png)
The view will now be updated with the filtered feature toggles.
## Assigning project to a new feature toggle {#assigning-project-to-a-new-feature-toggle}
When creating a new feature toggle, the project where the feature toggle will be created may be chosen. The default project is “Default”
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.
![Project concept](/img/projects_change_project.png)
![A form to create a toggle. An arrow points to an input labeled \"project\".](/img/projects_change_project.png)
All available projects are available from the drop-down menu.
![Project concept](/img/projects_toggle_project_dropdown.png)
![A form to create a toggle. The \"project\" input is expanded to show projects you can create the toggle in.](/img/projects_toggle_project_dropdown.png)
## Change project for an existing feature toggle {#change-project-for-an-existing-feature-toggle}
There might be a need to change the project a feature toggle belongs to. Changing the project is possible from the feature toggle configuration page.
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.
![Project concept](/img/projects_existing_toggle_dropdown.png)
To change the project, simply change the project from the drop-down menu.
![A feature toggle's settings tab. The project setting shows a dropdown to change projects.](/img/projects_existing_toggle_dropdown.png)