Skip to content

TF-31348 - Adds documentation for queries api [Dont Merge Yet] #1175

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
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

TF-31348 - Adds documentation for queries api [Dont Merge Yet] #1175

wants to merge 2 commits into from

Conversation

@sowju-hashicorp
Copy link

@sowju-hashicorp sowju-hashicorp commented Oct 23, 2025 •
edited by paulanunda
Loading

Description

🎫 Jira ticket

Adds documentation for queries api

Requested review scope:

  • Content touched by the PR only (typos, clarifications, tips)
  • Code test (command and code block changes)
  • Flow and language near changes (new/rearranged steps)
  • Review everything (rewrites, major changes)

Review urgency:

  • ASAP (bug fixes, broken content, imminent releases)
  • 3 days (small changes, easy reviews)
  • 1 week (default)
  • Best effort (very non-urgent)

All updates:

I have:

  • Verified that all status checks have passed
  • Verified that preview environment has successfully deployed
  • Verified appropriate label applied (hcp + product name)
  • Added all required reviewers (code owners and external)

Content checklist (optional)

Please do these things before requesting a review. I have:

  • Made any associated code repositories public
  • Added the hashicorp-education/teamName to any additional code or example repos as repo admin
  • Added redirects for any moved or removed pages
  • Spell checked the tutorial(s)
  • Followed the unified style guide
  • Linted code snippets (Details per language here)
  • Checked the steps for completeness (no steps are implied or hidden)
  • Looked at the local or vercel build and checked each new or changed page for:
    • display on the product curriculum page
    • callout box formatting
    • code block highlighting
    • right-hand navigation
    • next and back buttons
    • URL path

@sowju-hashicorp sowju-hashicorp requested a review from a team as a code owner October 23, 2025 21:06
@hashicorp-cla-app
Copy link

hashicorp-cla-app bot commented Oct 23, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 23, 2025 •
edited
Loading

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Fri Oct 31 20:49:35 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Fri Oct 31 20:43:26 UTC 2025

@github-actions
Copy link
Contributor

github-actions bot commented Oct 23, 2025 •
edited
Loading

Broken Link Checker

No broken links found! 🎉

sebasslash
sebasslash reviewed Oct 24, 2025
View reviewed changes
Copy link

@sebasslash sebasslash left a comment

Choose a reason for hiding this comment

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

One more thing and it's good to go 😄

trujillo-adam
trujillo-adam reviewed Oct 27, 2025
View reviewed changes
Copy link
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

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

This documentation looks good. I added some suggestions for consistency with the style guide, but no issues with the structure or usability. Let me know when you've addressed the feedback and I'll give it another quick scan.

@sowju-hashicorp sowju-hashicorp requested a review from a team as a code owner October 27, 2025 19:16
@sowju-hashicorp sowju-hashicorp force-pushed the TF-31348 branch 2 times, most recently from 2ade602 to 490bacf Compare October 27, 2025 19:40
trujillo-adam
trujillo-adam approved these changes Oct 28, 2025
View reviewed changes
Copy link
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks!

@paulanunda
Copy link

paulanunda commented Oct 31, 2025

@sowju-hashicorp should "Query" be added to the left-nav?
CleanShot 2025-10-31 at 11 25 02@2x

paulanunda
paulanunda requested changes Oct 31, 2025
View reviewed changes
@paulanunda paulanunda changed the title Adds documentation for queries api TF-31348 - Adds documentation for queries api Oct 31, 2025
@trujillo-adam trujillo-adam self-requested a review October 31, 2025 16:01
trujillo-adam
trujillo-adam requested changes Oct 31, 2025
View reviewed changes
Copy link
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

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

We also need to update the content/terraform-docs-common/data/cloud-docs-nav-data.json file to add the new page in the sidebar.

@sowju-hashicorp sowju-hashicorp changed the title TF-31348 - Adds documentation for queries api TF-31348 - Adds documentation for queries api [Dont Merge Yet] Oct 31, 2025
trujillo-adam
trujillo-adam approved these changes Oct 31, 2025
View reviewed changes
Copy link
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@paulanunda paulanunda paulanunda approved these changes

@sebasslash sebasslash sebasslash approved these changes

@trujillo-adam trujillo-adam trujillo-adam approved these changes

@williamdalessandro williamdalessandro williamdalessandro approved these changes

@niralpokalibm niralpokalibm niralpokalibm approved these changes

Assignees

No one assigned

Labels

HCP Terraform

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@sowju-hashicorp @paulanunda @sebasslash @trujillo-adam @williamdalessandro @niralpokalibm