Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update content and images for lifecycle label updates #877

Merged
merged 2 commits into from
Oct 17, 2024
Merged

Update content and images for lifecycle label updates #877

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
083a317
update content and images for lifecycle label updates
tbenning Oct 16, 2024
9161e0e
Fix HTML line break tags in table
tbenning Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions content/ui-patterns/feature-onboarding.mdx
View file
Open in desktop
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am good

Original file line number Diff line number Diff line change
Expand Up @@ -340,13 +340,13 @@ When using a dashboard feature bulletin:
<p>An announcement about GitHub Teams in the feature preview bulletin leads to an off-platform marketing page.</p>
</Box>

### Beta feature preview dialog
### Feature preview dialog

Feature previews allow teams to test features in production with users who opt in. A feature under the beta preview will be added to the Feature Preview dialog, accessible through the user dropdown.
Feature previews allow teams to test features in production with users who opt in. A feature under private or public preview will be added to the Feature Preview dialog, accessible through the user dropdown.

**Note:** Features in beta testing should have a comprehensive release and redaction plan. No feature should remain in beta for longer than 2 months unmonitored.
**Note:** Features in preview should have a comprehensive release and redaction plan. No feature should remain in preview for longer than 2 months unmonitored.

![Beta feature preview dialog](https://user-images.githubusercontent.com/6744014/89245313-6b107f80-d5bd-11ea-86cb-b697c61a2d99.png)
![Feature preview dialog](https://user-images.githubusercontent.com/6744014/89245313-6b107f80-d5bd-11ea-86cb-b697c61a2d99.png)

## Lifecycles (labels)

Expand All @@ -358,33 +358,34 @@ If the label is not part of a navigational item then it's important to include a
### Lifecycles

Depending on the size and impact of your ship you might only release to a fraction of users.
There are currently 4 main lifecycles: `Alpha`, `Beta (Private | Public | Limited public)`, `General audience (GA)` and `Deprecation`.
The `Alpha` lifecycle is often referred to as a `Staff ship` within GitHub.
There are currently 4 main lifecycles: `Private preview`, `Public preview`, `General availability (GA)` and `Deprecation`.
The `Private preview` lifecycle is often referred to as a `Staff ship` within GitHub.

| Preview | Name | Users | Required (unless navigation) |
| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | --------------------- | ------------------------------ |
| <img width="177" src="https://user-images.githubusercontent.com/980622/205132473-cf383aec-23bd-4aff-8cb3-fa55d6605017.png" /> | Alpha | Internal | Include a `Give feedback` link |
| <img width="177" src="https://user-images.githubusercontent.com/980622/205132479-f06472d3-f284-483d-83c4-d4fcb6e34827.png" /> | (Private, Limited, Public) Beta | Internal and external | Include a `Give feedback` link |
| <img width="177" src="https://user-images.githubusercontent.com/980622/205132482-4fbc72e8-f206-4a42-8f90-ffbd5f76f565.png" /> | General audience | Everyone | Include a `Give feedback` link |
| <img width="177" src="https://user-images.githubusercontent.com/980622/205132483-d0e172a7-5c14-4687-a47f-ea31914208a2.png" /> | Deprecation | Everyone | Include a `Learn more` link |
Note: The `Technical preview` label may sometimes be used by the Next team for experiments and research projects.

We recommend gathering feedback through a discussion to enable seamless follow-up with the user. This discussion should specify the changes made, providing clarity to the user about what's new. In case of deprecating a feature, it's crucial to provide additional information through our documentation. Note that features that were never promoted beyond the `Alpha` lifecycle do not need to go through a deprecation lifecycle.
||Stage|Details|
|--|--|--|
| ![private preview](https://github.com/user-attachments/assets/c509e399-0b44-4009-8fed-708042aa33b8) |**Private Preview** <br/>(formerly Alpha, Private Beta, Staff) |- Not publicly announced<br/>- Support handled by the product and engineering team (no SLAs) |
| ![public preview](https://github.com/user-attachments/assets/3f549ab1-3b1c-425d-b7c3-95c591bed4fc) |**Public Preview** <br/>(formerly Limited Public Beta, Public Beta) |- Publicly announced<br/>- Customers should not yet take production dependencies on the service (no SLAs)<br/>- Support handled by the product and engineering teams. With VP Support approval, exceptions allow the Support team to handle tickets. |
| | **General Availability** |- Available to ALL GHEC Customers<br/>- SLAs apply (where applicable, some products do not have SLAs)<br/>- Support provided |

We recommend gathering feedback through a discussion to enable seamless follow-up with the user. This discussion should specify the changes made, providing clarity to the user about what's new. In case of deprecating a feature, it's crucial to provide additional information through our documentation. Note that features that were never promoted beyond the `Private preview` lifecycle do not need to go through a deprecation lifecycle.

### Color and terminology

It's important to stick to the correct terminology and label color when referring to a lifecycle.
It's important to stick to the correct terminology and label color when referring to a lifecycle. We no longer use the terms Alpha or Beta to identify stages and instead preview Private preview and Preview in the UI.

<DoDontContainer>
<Do>
<img src="https://user-images.githubusercontent.com/980622/205090973-2c05a0d8-3406-4d54-9e6d-00b29e236395.png" />
<img src="https://github.com/user-attachments/assets/eeb37741-4b3a-451c-8906-47e7916016f9" alt="public preview label" />
<Caption>Use the correct label and link color</Caption>
</Do>
<Dont>
<img src="https://user-images.githubusercontent.com/980622/205090963-c5889708-12bc-44ca-8a9e-801612c92656.png" />
<img src="https://user-images.githubusercontent.com/980622/205090963-c5889708-12bc-44ca-8a9e-801612c92656.png" alt="mistaken beta label wrong color" />
<Caption>Don't change the label or link color</Caption>
</Dont>
</DoDontContainer>

### Label usage and guidelines

For more information on how to properly use labels in the product, [please refer to the design guidelines.](../components/label/)
For more information on how to properly use labels in the product, [please refer to the design guidelines.](../components/label/)
Loading