Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

TF-9289 document priority varsets #458

Merged
merged 6 commits into from
Oct 30, 2023
Merged

TF-9289 document priority varsets #458

merged 6 commits into from
Oct 30, 2023

Conversation

rberecka
Copy link
Contributor

@rberecka rberecka commented Sep 28, 2023 •
edited
Loading

What

Add the priority field to the Variable Sets API doc.
Add information about priority variable sets to docs on managing variables and variable precedence.

Links to Vercel pages changed for reviewer:
API Docs: https://terraform-docs-common-git-tf-9289-update-produ-7bf970-hashicorp.vercel.app/terraform/cloud-docs/api-docs/variable-sets

Managing Variables: https://terraform-docs-common-git-tf-9289-update-produ-7bf970-hashicorp.vercel.app/terraform/cloud-docs/workspaces/variables/managing-variables#priority-variable-sets

Variable Precedence: https://terraform-docs-common-git-tf-9289-update-produ-7bf970-hashicorp.vercel.app/terraform/cloud-docs/workspaces/variables#precedence-with-priority-variable-sets

Why

This is for CCE-266. The related RFC is here.

Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

  • One or more labels describe the type of change (e.g. clarification) and associated product (e.g. tfc).
  • Description links to related pull requests or issues, if any.

Content

  • [ NA] Redirects have been added to website/redirects.js for moved, renamed, or deleted pages.
  • API documentation and the API Changelog have been updated.
  • [ NA] Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • Pages with related content are updated and link to this content when appropriate.
  • [NA] Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • [NA] New pages have metadata (page name and description) at the top.
  • [NA] New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
  • New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
  • [NA] UI elements (button names, page names, etc.) are bolded.
  • The Vercel website preview successfully deployed.

Reviews

  • I or someone else reviewed the content for technical accuracy.
  • I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

@vercel
Copy link

vercel bot commented Sep 28, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
terraform-docs-common ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 30, 2023 5:00pm

@rberecka rberecka added the enhancement New feature or request label Sep 28, 2023
@rberecka rberecka force-pushed the TF-9289-update-product-docs-for-priority-varsets branch from ef26638 to 4d2a2a1 Compare September 28, 2023 18:24
@rberecka rberecka mentioned this pull request Sep 28, 2023
Merged
@rberecka rberecka requested a review from ritsok September 28, 2023 18:39
@rberecka rberecka force-pushed the TF-9289-update-product-docs-for-priority-varsets branch from 4f99d28 to 1196334 Compare September 28, 2023 18:49
@rberecka
Copy link
Contributor Author

New diagram example:

image

@rberecka rberecka force-pushed the TF-9289-update-product-docs-for-priority-varsets branch 2 times, most recently from 5059fe6 to 7e83940 Compare October 24, 2023 21:48
ritsok
ritsok reviewed Oct 24, 2023
View reviewed changes
Copy link
Contributor

@ritsok ritsok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few final edits for passive voice and our style guide. please add the precedence hierarchy here https://terraform-docs-common-git-tf-9289-update-produ-7bf970-hashicorp.vercel.app/terraform/cloud-docs/workspaces/variables#precedence, then feel free to ship!

@rberecka rberecka force-pushed the TF-9289-update-product-docs-for-priority-varsets branch from 6d08c65 to e0b0896 Compare October 24, 2023 23:23
ritsok
ritsok approved these changes Oct 25, 2023
View reviewed changes
Copy link
Contributor

@ritsok ritsok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! thank you 🚢

@rberecka rberecka marked this pull request as ready for review October 30, 2023 16:55
@rberecka rberecka merged commit 15bd29f into main Oct 30, 2023
@rberecka rberecka deleted the TF-9289-update-product-docs-for-priority-varsets branch October 30, 2023 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shernandez5 shernandez5 shernandez5 left review comments

@ritsok ritsok ritsok approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rberecka @ritsok @shernandez5