Skip to content

Conversation

laurapacilio
Copy link
Contributor

@laurapacilio laurapacilio commented Jul 25, 2022

What

We updated the Runs page in workspaces to allow users to filter the runs list by status, operation, and source - hooray! We updated the API docs, but we also need to update this page as well :-) This PR updates the outdated Navigating Runs section of this page.

It also removes excess screenshots that are out-of-date and fixes the rest of the page copy so that it better aligns with our style guide. :-)

Why

Fix the outdated docs to align with the current product!


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 25, 2022

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

Name Status Preview Updated
terraform-docs-common ✅ Ready (Inspect) Visit Preview Jul 26, 2022 at 10:05PM (UTC)

Copy link
Contributor

@mjyocca mjyocca left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link
Contributor

@mgarrell777 mgarrell777 left a comment

Choose a reason for hiding this comment

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

Hey @laurapacilio I'm Matthew, new technical writer on Terraform ;)

Thank you for your efforts here. Just a few minor suggestions. But otherwise looks good.

laurapacilio and others added 6 commits July 26, 2022 17:59
Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>
Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>
Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>
Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>
Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>
Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>
@laurapacilio laurapacilio merged commit 0d26d5b into main Jul 26, 2022
@laurapacilio laurapacilio deleted the update-runs-page-filters branch July 26, 2022 22:05
hashibot-web added a commit that referenced this pull request May 16, 2023
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