mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-28 00:06:53 +01:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
99 lines
5.7 KiB
Markdown
99 lines
5.7 KiB
Markdown
---
|
||
id: projects
|
||
title: 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 {#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](./environments.md) 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 {#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 UI shows the currently available projects. To create a new project, use the “new project” button.
|
||
|
||
|
||
|
||
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 {#deleting-an-existing-project}
|
||
|
||
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.
|
||
|
||
|
||
|
||
2. Click on Delete Project
|
||
|
||
|
||
|
||
## 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 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. You can use the search to filter to a specific project or even for multiple projects in the same time if you need.
|
||
|
||
|
||
|
||
In the search you can type "project:specific-name" to filter that project only.
|
||
|
||
|
||
|
||
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 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 {#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.
|
||
|
||
|