Skip to content

Conversation

@sowju-hashicorp
Copy link

@sowju-hashicorp sowju-hashicorp commented Oct 23, 2025

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

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 23, 2025

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Fri Oct 24 21:02:21 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Fri Oct 24 20:55:50 UTC 2025

@github-actions
Copy link
Contributor

github-actions bot commented Oct 23, 2025

Broken Link Checker

No broken links found! 🎉

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 😄


### Log Read URL

The `log-read-url` attribute contains a URL to retrieve the logs for the Query Run.
Copy link

@sebasslash sebasslash Oct 24, 2025

Choose a reason for hiding this comment

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

One thing that's missing at the end is a Available Related Resources section (see example). For queries, the list is: configuration_version, created_by, configuration_version.ingress_attributes

Copy link
Author

Choose a reason for hiding this comment

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

@sebasslash I made the changes. Please let me know if everything looks good.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants