Add instructions for publishing TFE docs #1078
Open
+225
−0
Conversation
This file contains hidden or 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
Vercel Previews Deployed
|
trujillo-adam
commented
Oct 10, 2025
trujillo-adam
commented
Oct 10, 2025
Co-authored-by: hamza <[email protected]>
rkoron007
reviewed
Oct 10, 2025
|
|
||
| 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`. | ||
|
|
||
| If you need to update any existing documentation, 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. |
There was a problem hiding this comment.
@trujillo-adam I think you forgot to update this to internal! You can do this in the terraform-docs-common folder in the same PR, and we should tell people to do that!
There was a problem hiding this comment.
Suggested change
| If you need to update any existing documentation, 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. | |
| 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. |
rkoron007
reviewed
Oct 10, 2025
|
|
||
| Review and merge any other PRs opened against the release branch. | ||
|
|
||
| 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. Refer to [Release notes guidance](#release-notes-guidance) for assistance. |
There was a problem hiding this comment.
We shouldn't say "merge" if we don't want to be the ones merging
Suggested change
| 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. Refer to [Release notes guidance](#release-notes-guidance) for assistance. | |
| 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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds updated instructions for how to publish Terraform Enterprise documentation to the repository documentation.
The intent is to:
For future scalability, I created subfolders so that other product groups can add documentation to support any of their non-standard workflows.