hashicorp / terraform-docs-agents

Content for Terraform's agents documentation.
terraform-docs-agents.vercel.app
Mozilla Public License 2.0
7 stars 15 forks source link

Update Docs - Remove Screenshots, Reorganize content, Fix style concerns #17

Closed laurapacilio closed 1 year ago

laurapacilio commented 2 years ago

What

Reworking some parts of the documentation to make navigation easier/break up the huge index page of content. Also removing all screenshots in anticipation of Unified Navigation effort.

Specifically, this PR does the following:

Why

Cloud Agents are really great, and I want to make sure the docs are structured in the best way to serve users. These changes should help improve the user experience, improve the maintainability of these docs, and also help them adhere to the style guidelines we're implementing across the rest of the Terraform documentation set.

Screenshots

Before

Screen Shot 2022-08-17 at 12 29 47 PM

After

Screen Shot 2022-08-18 at 12 09 29 PM

TODO: Add redirects in terraform-website for key headings that were moved, e.g. "Scoping Agents to Specific Workspaces". These may be linked from places in the TFC docs and we want to make sure we don't break those links for users.


Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

Content

Reviews

vercel[bot] commented 2 years ago

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

Name Status Preview Updated
terraform-docs-agents ✅ Ready (Inspect) Visit Preview Aug 31, 2022 at 7:24PM (UTC)