Skip to content

Commit 6de9313

Browse files
Add examples (#1079)
2 parents def6b1b + da8274c commit 6de9313

File tree

1 file changed

+56
-30
lines changed

1 file changed

+56
-30
lines changed

docs/workflows/infrastructure-group/publish-tfe-docs.md

Lines changed: 56 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Terraform Enterprise quarterly releases
22

3-
This page describes the process for publishing Terraform Enterprise documentation. Terraform Enterprise adheres to the following semantic versioning scheme:
3+
This page describes the process for publishing Terraform Enterprise documentation. Terraform Enterprise adheres to the following semantic versioning scheme:
44

55
`MILESTONE.MAJOR.PATCH`
66

@@ -18,34 +18,34 @@ More details -
1818
-> GA Release Publish: week of November 9
1919
```
2020

21-
Ask for the dates in the channel if it has been more than six weeks since the last milestone or major version and the manager hasn't posted the dates yet. You should also verify that the dates haven't changed closer to the standing date.
21+
Ask for the dates in the channel if it has been more than six weeks since the last milestone or major version and the manager hasn't posted the dates yet. You should also verify that the dates haven't changed closer to the standing date.
2222

2323
**Application Code Deadline**: Also called **app deadline**, this is the Terraform Enterprise code freeze and occurs 1.5 to 2 weeks before the release date. App deadline is also when the release engineer runs a GitHub workflow in the `web-unified-docs-internal` repository that creates the following artifacts:
2424

25-
- A branch named `tfe-release/<milestone>.<major>.x` for assemblying the release notes and documentation updates. This is the branch that you merge into `main` to publish the docs.
26-
- A branch named `HCPTF-diff/<milestone>.<major>.x` that contains a diff of all of the new content from HCP TF slated for the next Terraform Enterprise release.
27-
- A PR named `HCP TF changes for TFE release <milestone>.<major>.x` for merging content updates into the release notes into the assembly branch. Review this PR and merge into the assembly branch.
28-
- A PR named `TFE Release <milestone>.<major>.x` for merging the release notes into the assembly branch.
25+
- A branch named `tfe-release/<milestone>.<major>.x` for assembling the release notes and documentation updates. This is the branch that you merge into `main` to publish the docs.
26+
- A branch named `HCPTF-diff/<milestone>.<major>.x` that contains a diff of all of the new content from HCP TF slated for the next Terraform Enterprise release.
27+
- A PR named `HCP TF changes for TFE release <milestone>.<major>.x` for merging content updates into the release notes into the assembly branch. Review this PR and merge into the assembly branch.
28+
- A PR named `TFE Release <milestone>.<major>.x` for merging the release notes into the assembly branch.
2929

30-
Refer to the [TFE RElease 1.0.0](https://github.com/hashicorp/web-unified-docs-internal/pull/299) to see examples of the app deadline artifacts.
30+
Refer to the [TFE Release 1.0.0](https://github.com/hashicorp/web-unified-docs-internal/pull/299) to see examples of the app deadline artifacts.
3131

3232
**Backport Deadline**: This is an engineering deadline and isn't actionable for IPG team members.
3333

3434
**GA Release Publish**: On this date, merge the assembly branch into `main` to publish the documentation.
3535

36-
## Before app deadline
36+
## Before app deadline
3737

38-
Make sure to merge any PRs against the `terraform-docs-common` folder that should be included in the upcoming Terraform Enterprise release.
38+
Make sure to merge any PRs against the `terraform-docs-common` folder that should be included in the upcoming Terraform Enterprise release.
3939

4040
Apply any exclusion tags to prevent HCP Terraform-specifc content from publishing to the enterprise docs. Refer to [Exclusion tag syntax](#exclusion-tag-syntax) for details.
4141

4242
## Before GA release
43-
44-
Review and merge the `HCP TF changes for TFE release <milestone>.<major>.x` PR into the `tfe-release/<milestone>.<major>.x` branch. During your review, verify that all of the changes are appropriate for Terraform Enterprise. If you’re unsure about an item, you can also ask in `#proj-tfe-releases`.
43+
44+
Review and merge the `HCP TF changes for TFE release <milestone>.<major>.x` PR into the `tfe-release/<milestone>.<major>.x` branch. During your review, verify that all of the changes are appropriate for Terraform Enterprise. If you’re unsure about an item, you can also ask in `#proj-tfe-releases`.
4545

4646
If you need to address poorly-written content or if you need to apply exclusion tags, you must also apply the changes to the corresponding files in the public `web-unified-docs` repository so that the next synchronization doesn't overwrite your changes.
4747

48-
Review and merge the `TFE Release <milestone>.<major>.x` release notes PR. The release engineer is responsible for merging the PR. The release engineer also prepares the release notes section of the docs.
48+
Review and merge the `TFE Release <milestone>.<major>.x` release notes PR. The release engineer is responsible for merging the PR. The release engineer also prepares the release notes section of the docs.
4949

5050
Review and merge any other PRs opened against the release branch.
5151

@@ -55,47 +55,75 @@ The release engineer merges `tfe-release/<milestone>.<major>.x` release branch i
5555

5656
---
5757

58-
## Apendix
58+
## Appendix
5959

6060
This section contains supplementary information for publishing Terraform Enterprise docs.
6161

62-
### Manually create docs artifacts for the release
62+
### Manually create docs artifacts for the release
6363

6464
The [Create TFE Release Notes](https://github.com/hashicorp/web-unified-docs-internal/actions/workflows/create-tfe-release-notes.yml) action creates the release notes PR and triggers the [Copy Cloud Docs For TFE](https://github.com/hashicorp/web-unified-docs-internal/actions/workflows/copy-cloud-docs-for-tfe.yml) action. These actions create the branches and PRs necessary for publishing a new version of the Terraform Enterprise documenation. Complete the following steps to manually run the actions:
6565

66-
1. Log into GitHub and navigate to the `web-unified-docs-internal` repository.
66+
1. Log into GitHub and navigate to the `web-unified-docs-internal` repository.
6767
1. Click **Actions**, then choose **Create TFE Release Notes** from the **Actions** sidebar.
6868
1. Open the **Run workflow** dropdown and choose the branch to use to run the workflow. This is `main` in almost all cases.
6969
1. Specify the following values:
70-
- Enter the upcoming version of the TFE release.
70+
- Enter the upcoming version of the TFE release.
7171
- Enter the release branch for the upcoming release. Omit the suffix. You must specify an existing release branch.
72-
- Enter the tag of the most recent TFE release. The workflow uses this version to generate the change log.
72+
- Enter the tag of the most recent TFE release. The workflow uses this version to generate the change log.
7373

7474
### Exclusion tag syntax
7575

76-
Most content in the Terraform Enterprise documentation is sourced from the `terraform-docs-common` folder shared with HCP Terraform, but some features, such as operating HCP Terraform in Europe and tiered pricing, are specific to the SaaS offering. There is also sometimes a lag between when a feature releases in HCP Terraform and lands in Terraform Enterprise. For this reason, you will need to mark content in the `terraform-docs-common` folder as HCP Terraform-only to exclude it from the Terraform Enterprise documentation. Conversely, you can apply an exclusion tag to prevent information that should only appear in Terraform Enterprise.
76+
Most content in the Terraform Enterprise documentation is sourced from the `terraform-docs-common` folder shared with HCP Terraform, but some features, such as operating HCP Terraform in Europe and tiered pricing, are specific to the SaaS offering. There is also sometimes a lag between when a feature releases in HCP Terraform and lands in Terraform Enterprise. For this reason, you will need to mark content in the `terraform-docs-common` folder as HCP Terraform-only to exclude it from the Terraform Enterprise documentation. Conversely, you can apply an exclusion tag to prevent information that should only appear in Terraform Enterprise.
7777

7878
You can exclude page-level content as well as entire MDX files.
7979

80-
#### Page-level exclusions
81-
82-
Use HTML comment tags to add a `BEGIN:` and an `END:` exclusion directive:
80+
#### Exclude content on a page
81+
82+
Use HTML comment tags and add the `BEGIN: TFC:only` and `END: TFC:only` exclusion directives to exclude content from displaying in the Terraform Enterprise docs:
83+
84+
```mdx
85+
<!-- BEGIN: TFC:only name:<feature-name> -->
8386

87+
Content to exclude from Terraform Enterprise.
88+
89+
<!-- END: TFC:only name:<feature-name> -->
8490
```
85-
<!-- BEGIN: <TFC-or-TFEnterprise>:only name:<feature-name> -->
8691

87-
Content to exclude from HCP Terraform or Terraform Enterprise
92+
You can alternatively exclude content from displaying on the HCP Terraform docs using `BEGIN: TFEnterprise:only` and `END: TFEnterprise:only` exclusion directives:
93+
94+
```mdx
95+
<!-- BEGIN: TFEnterprise:only name:<feature-name> -->
8896

89-
<!-- END: <TFC-or-TFEnterprise>:only name:<feature-name> -->
97+
Content to exclude from HCP Terraform.
98+
99+
<!-- END: TFEnterprise:only name:<feature-name> -->
90100
```
91101

92-
Except for the `BEGIN:` and `END:` directives, the content of each tag must be identical, otherwise the platform recognizes them as different directives and returns an error.
102+
Except for the `BEGIN:` and `END:` directives, the content of each tag must be identical, otherwise the platform recognizes them as different directives and returns an error. The `name` attribute is optional, but it is especially helpful for staying organized when the page contains several exclusions.
103+
104+
You can exclude MDX components, such as callouts, but there must be a line break between the components and the exclusion directives:
93105

94-
The `name` attribute is optional, but it is especially helpful for staying organized when the page contains several exclusions.
106+
```mdx
107+
<!-- BEGIN: TFC:only name:<feature-name> -->
95108

96-
#### Exclude an MDX file
109+
<Note>
97110

98-
To exclude an entire file, add `tfc_only: true` to the page's front matter. For example:
111+
Message here.
112+
113+
</Note>
114+
115+
<!-- END: TFC:only name:<feature-name> -->
116+
```
117+
118+
You can also exclude content mid-sentence, but pay extra attention to your spacing and punctuation:
119+
120+
```mdx
121+
Project-level permissions apply to all workspaces<!-- BEGIN: TFC:only name:stacks-tfe --> and Stacks<!-- END: TFC:only name:stacks-tfe --> within a specific project.
122+
```
123+
124+
#### Exclude an entire MDX file
125+
126+
To exclude an entire file from Terraform Enterprise, add `tfc_only: true` to the page's front matter. For example:
99127

100128
```
101129
---
@@ -105,5 +133,3 @@ description: >-
105133
tfc_only: true
106134
---
107135
```
108-
109-

0 commit comments

Comments
 (0)