Skip to content

Commit 1f791e1

Browse files
morsapaesbenesch
andauthored
doc/developer: minor patches to project lifecycle (#24997)
--------- Co-authored-by: Nikhil Benesch <[email protected]>
1 parent aa7e081 commit 1f791e1

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

doc/developer/project-lifecycle.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ The DRI is responsible for communicating progress through these
1212
lifecycle phases by:
1313

1414
- Updating the "Lifecycle" tag on the associated GitHub Epic.
15-
- Optionally, announcing the update in #epd-announce and #ohship.
15+
- Optionally, announcing the update in `#epd-announce` and
16+
`#shipped-it`.
1617

1718
## Internal Development
1819

@@ -41,16 +42,16 @@ Before a project can move to Private Preview, it must:
4142
- Cause stability issues for other parts of the system.
4243
- Live behind a gated feature flag (disabled by default).
4344
- Have basic tests live and running.
44-
- Have basic reference documentation live behind a {{< private-preview >}} flag.
45+
- Have basic reference documentation live behind a `{{< private-preview >}}` flag.
4546
- Have its GitHub epic status set to "Private Preview".
4647

4748
## Private Preview
4849

4950
The goal of Private Preview is to identify and address all of
5051
the reasons why the solution might not work. To do this, the
5152
DRI is responsible for getting the solution in front of relevant
52-
internal (e.g. DevEx) and external (e.g. customers) testers.
53-
It is recommended to kick this off by posting to #epd-announce
53+
internal (e.g. testing team, analytics team) and external (e.g. customers) testers.
54+
It is recommended to kick this off by posting to `#epd-announce`
5455
and asking for support on identifying testers. Customer-facing
5556
teams such as field engineering are well-positioned to provide
5657
guidance on external testers. If you're unsure how to proceed,
@@ -83,12 +84,12 @@ Before a project can move to Public Preview, it must:
8384
- Have addressed all known stability issues.
8485
- Have addressed all known limitations, except those that are explicitly out of scope.
8586
- Support all known customer configurations, except those that are explicitly out of scope.
86-
- Have polished reference documentation published with a {{< private-preview >}} notice.
87+
- Have polished reference documentation published with a `{{< private-preview >}}` notice.
8788

8889
To move a feature to Public Preview:
8990

90-
- Update any documentation about the feature to use the {{< public-preview >}} notice.
91-
- Add a release note with a {{< public-preview >}} flag.
91+
- Update any documentation about the feature to use the `{{< public-preview >}}` notice.
92+
- Add a release note with a `{{< public-preview >}}` flag.
9293
- Update the GitHub epic status to "Public Preview".
9394
- Enable the feature flag in all environments.
9495

@@ -113,7 +114,7 @@ Before a project can move to General Availability, it must:
113114

114115
To move a project to General Availability:
115116

116-
- Remove the {{< public-preview >}} notice from the documentation.
117+
- Remove the `{{< public-preview >}}` notice from the documentation.
117118
- Write a blog post describing the project, or explicitly
118119
justify why a blog post is not required.
119120
- Write a release note announcing that the project is in General Availability.

0 commit comments

Comments
 (0)