Skip to content
This repository was archived by the owner on Sep 4, 2025. It is now read-only.

Conversation

@laurapacilio
Copy link
Contributor

What

We're shipping versioned documentation for Cloud Agents. This PR adds context to the README about deployment, to help folks understand when their changes will be live on the site. This is to match work we've done in other repositories.

Why

Help contributors understand how to make their content live/how the site generates versioned documentation for Cloud Agents.


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

  • Redirects have been added for moved, renamed, or deleted pages. This requires a separate PR in the terraform-website repository redirects.next.js file.
  • API documentation and the API Changelog have been updated.
  • 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.
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • New pages have metadata (page name and description) at the top.
  • 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.
  • 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 Jul 27, 2022

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

Name Status Preview Updated
terraform-docs-agents ✅ Ready (Inspect) Visit Preview Jul 27, 2022 at 6:22PM (UTC)
@laurapacilio
Copy link
Contributor Author

@thiskevinwang - is this correct for how the Cloud Agents process is working?

Copy link
Contributor

@thiskevinwang thiskevinwang left a comment

Choose a reason for hiding this comment

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

1 typo, otherwise ✅

Copy link
Member

@ryanuber ryanuber left a comment

Choose a reason for hiding this comment

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

Seems good to me!

Co-authored-by: Kevin Wang <kwangsan@gmail.com>
@laurapacilio laurapacilio merged commit 2751fb0 into main Jul 27, 2022
@laurapacilio laurapacilio deleted the Update-README-versioned-docs branch July 27, 2022 18:18
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

3 participants