-
-
Notifications
You must be signed in to change notification settings - Fork 730
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: release template sidebar (#8871)
https://linear.app/unleash/issue/2-3026/release-template-sidebar-documentationcommand Implements the release plan template form sidebar / description. Took some liberties in the text compared to what we had in our sketches. Also includes some slight refactoring. ![image](https://github.com/user-attachments/assets/529bf306-b545-4efa-8330-afc19782765a)
- Loading branch information
Showing
8 changed files
with
142 additions
and
23 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
98 changes: 98 additions & 0 deletions
98
frontend/src/component/releases/ReleasePlanTemplate/TemplateFormDescription.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
import ReleaseTemplateIcon from '@mui/icons-material/DashboardOutlined'; | ||
import { ReactComponent as MilestoneIcon } from 'assets/icons/milestone.svg'; | ||
import { styled } from '@mui/material'; | ||
|
||
const StyledDescription = styled('div')(({ theme }) => ({ | ||
display: 'flex', | ||
flexDirection: 'column', | ||
gap: theme.spacing(2), | ||
fontSize: theme.fontSizes.smallBody, | ||
})); | ||
|
||
const StyledDescriptionHeader = styled('div')(({ theme }) => ({ | ||
display: 'flex', | ||
alignItems: 'center', | ||
gap: theme.spacing(1), | ||
fontSize: theme.fontSizes.bodySize, | ||
fontWeight: theme.fontWeight.bold, | ||
})); | ||
|
||
const StyledExampleUsage = styled('div')(({ theme }) => ({ | ||
display: 'flex', | ||
flexDirection: 'column', | ||
gap: theme.spacing(1), | ||
})); | ||
|
||
const StyledMilestones = styled('div')(({ theme }) => ({ | ||
display: 'flex', | ||
flexDirection: 'column', | ||
gap: theme.spacing(2), | ||
})); | ||
|
||
const StyledLabel = styled('p')(({ theme }) => ({ | ||
fontWeight: theme.fontWeight.bold, | ||
})); | ||
|
||
const StyledMilestoneHeader = styled('div')(({ theme }) => ({ | ||
display: 'flex', | ||
alignItems: 'center', | ||
gap: theme.spacing(1), | ||
})); | ||
|
||
export const TemplateFormDescription = () => { | ||
return ( | ||
<StyledDescription> | ||
<StyledDescriptionHeader> | ||
<ReleaseTemplateIcon /> | ||
Release templates | ||
</StyledDescriptionHeader> | ||
<p> | ||
Standardize your team's approach to rolling out new | ||
functionality with release templates. These templates allow you | ||
to predefine strategies, or groups of strategies, making it | ||
easier to set up new flags and ensure alignment in how rollouts | ||
are managed. | ||
</p> | ||
<p> | ||
Customize templates to suit your needs by adding strategies to | ||
specific milestones. Each milestone will execute sequentially, | ||
streamlining your release process. | ||
</p> | ||
<StyledExampleUsage> | ||
<StyledLabel>Example usage</StyledLabel> | ||
<StyledMilestones> | ||
<div> | ||
<StyledMilestoneHeader> | ||
<MilestoneIcon /> | ||
Milestone 1 | ||
</StyledMilestoneHeader> | ||
<p> | ||
Enable the feature for internal teams to test | ||
functionality and resolve initial issues. | ||
</p> | ||
</div> | ||
<div> | ||
<StyledMilestoneHeader> | ||
<MilestoneIcon /> | ||
Milestone 2 | ||
</StyledMilestoneHeader> | ||
<p> | ||
Expand the rollout to 20% of beta users to gather | ||
feedback and monitor performance. | ||
</p> | ||
</div> | ||
<div> | ||
<StyledMilestoneHeader> | ||
<MilestoneIcon /> | ||
Milestone 3 | ||
</StyledMilestoneHeader> | ||
<p> | ||
Release the feature to all users after confirming | ||
stability and addressing earlier feedback. | ||
</p> | ||
</div> | ||
</StyledMilestones> | ||
</StyledExampleUsage> | ||
</StyledDescription> | ||
); | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,6 +42,7 @@ export const useTemplateForm = ( | |
return { | ||
name, | ||
description, | ||
milestones, | ||
}; | ||
}; | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters