Skip to content

Commit 4feafd7

Browse files
committed
formatting tweaks
1 parent 8a3c02d commit 4feafd7

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,8 @@ Apply any exclusion tags to prevent HCP Terraform-specifc content from publishin
4343

4444
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

46-
If you need to update any existing documentation or apply exclusion tags, you must also apply the changes to the corresponding files in the `terraform-docs-common` so that the next synchronization doesn't overwrite your changes.
46+
If you need to update any existing documentation or apply exclusion tags, you must also apply the changes to the corresponding files in the `terraform-docs-common` so that the next synchronization doesn't overwrite your changes. It's rare, but if you edit a file in the `terraform-docs-common` folder as part of your review, someone may edit and merge the same file in the public repository, resulting in collisions when merging to `main`. You may need to track down the author or reach out to one of the development teams to resolve merge conflicts that emerge in this scenario.
4747

48-
It's rare, but if you edit a file in the `terraform-docs-common` folder as part of your review, someone may edit and merge the same file in the public repository, resulting in collisions when merging to `main`. You may need to track down the author or reach out to one of the development teams to resolve merge conflicts that emerge in this scenario.
4948
Review and merge any other PRs opened against the release branch.
5049

5150
Review 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. Refer to [Release notes guidance](#release-notes-guidance) for assistance.
@@ -220,7 +219,6 @@ The private registry UI now displays a warning message for old versions of provi
220219

221220
Per the style guide, [address the reader as "you"](../../style-guide/general/point-of-view.md#address-the-reader-as-you).
222221

223-
224222
#### Format single updates as a paragraph
225223

226224
A list with one item isn’t a list. If there is only one update in a section, format it as a paragraph.

0 commit comments

Comments
 (0)