Skip to content

Commit

Permalink
Feature Archiving Docs (#556)
Browse files Browse the repository at this point in the history
* Feature Archiving Docs

- added `Archiving a Feature` section  to Feature docs page
- updated the Status & Lifecycle page to include Archived as a new state
- updated descriptions for Deleting & Archiving a feature

* Update docs/essentials/features.md

Archving --> Archiving
  • Loading branch information
katemacfarlane authored Feb 13, 2024
1 parent 7cc9f48 commit eeeda2c
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
26 changes: 25 additions & 1 deletion docs/essentials/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,8 +367,31 @@ Feature settings including name, key, and type can be changed from feature page

---

## Archiving a Feature

Archiving is the terminal state for Features that have reached the end of their lifecycle, were never implemented in code, or have become entirely obsolete. See [Status & Lifecyle](/essentials/status-and-lifecycle) for more information on how to manage Feature Lifecycles in DevCycle.

Upon Archive, the Feature is put into a read-only mode, and its Audit Logs are accessible and available for teams to review. All [Variables](/essentials/variables) will be archived along with the Feature *but* can be re-used and associated to other Features. All Variables in this Feature will begin to serve Default values in code.

This action cannot be undone.

### From the CLI

*Coming Soon*

### From the Dashboard

To archive a Feature, either navigate to the Status section OR scroll to the very bottom of the feature page and click the `Archive` button. You will be prompted to confirm archival of the Feature.

---

## Deleting a Feature

We recommended that Feature deletion only be used for mistakes, as deletion permanently removes the Feature, its Variables and its Audit Log from DevCycle.

This action cannot be undone.


### From the CLI
To delete a feature for your selected project run:

Expand All @@ -384,4 +407,5 @@ You will be prompted to select a feature you would like to delete, and should be

### From the Dashboard

To delete a feature scroll to the very bottom of the feature page and click the red `Delete Feature Flag` button. You will be prompted to confirm deletion.
To delete a feature scroll to the very bottom of the feature page and click the red `Delete` button. You will be prompted to confirm deletion.

9 changes: 8 additions & 1 deletion docs/essentials/status-and-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,14 @@ One could consider a Feature "Complete" once it has been tested, approved, and i

### Archived

The "Archived" status is designed to clean up the dashboard and the codebase by essentially putting the Feature into a read-only mode and hiding it from the standard dashboard views. It can still be reverted from the "Archived" status to In Progress, allowing for future use.
The "Archived" status is designed to be the terminal state for Features that have reached the end of their lifecycle, were never implemented in code, or have become entirely obsolete.

A Feature should be archived after it has been cleaned up and its Variables removed from the codebase. Ideally, users should have also marked the Feature as **[Completed](/essentials/status-and-lifecycle#completed)** in DevCycle.

Archiving Features helps clean up your dashboard and codebase by essentially putting the Feature into a read-only mode and hiding it from the standard dashboard views. Archived Features' Audit Logs are accessible and available for teams to review.

Feature deletion still exists; however, it is recommended that Delete only be used for mistakes. Deletion permanently removes the Feature and its Audit Log from DevCycle. Keeping archived Features will allow a team to retain valuable information about its history and hopefully in the future, will allow DevCycle to make reports on the Feature lifecycle using that information.


## LifeCycle and Changing Status

Expand Down

0 comments on commit eeeda2c

Please sign in to comment.