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

Fix headers and links #97

Merged
merged 4 commits into from
May 1, 2024
Merged

Fix headers and links #97

merged 4 commits into from
May 1, 2024

Conversation

rkoron007
Copy link
Contributor

@rkoron007 rkoron007 commented Apr 17, 2024 •
edited
Loading

What

Small text changes.

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 Vercel
Copy link

vercel bot commented Apr 17, 2024 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
terraform-docs-agents ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 30, 2024 4:56pm

@rkoron007 rkoron007 changed the title Fix headers Fix headers and links Apr 17, 2024
@rkoron007 rkoron007 self-assigned this Apr 17, 2024
@rkoron007 rkoron007 added the documentation Improvements or additions to documentation label Apr 17, 2024
ryanuber
ryanuber requested changes Apr 17, 2024
View reviewed changes
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.

I think the comments I made about the changes to the auto-generated docs should be addressed - we should back out those changes here and instead make them in the tfc-agent source where they will generate the proper text when we do releases. Otherwise, this seems reasonable to me.

website/docs/cloud-docs/agents/changelog.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/agents/agents.mdx Outdated Show resolved Hide resolved
trujillo-adam
trujillo-adam approved these changes Apr 29, 2024
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.

Added a few suggestions that certainly don't rise to the level of egregious but might be small enough to pack in.

website/docs/cloud-docs/agents/hooks.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/agents/logging.mdx Outdated Show resolved Hide resolved
@rkoron007 @trujillo-adam
Apply suggestions from code review
cdce9b3 
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
ryanuber
ryanuber approved these changes May 1, 2024
View reviewed changes
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.

FYI, here is the tfc-agent PR to update our templates.

@rkoron007 rkoron007 merged commit d1e902c into main May 1, 2024
5 checks passed
@rkoron007 rkoron007 deleted the RK/fix-links branch May 1, 2024 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

@ryanuber ryanuber ryanuber approved these changes

Assignees

@rkoron007 rkoron007

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rkoron007 @ryanuber @trujillo-adam