reorg nav, link refs to usage#1449
Conversation
Vercel Previews Deployed
|
Broken Link CheckerNo broken links found! 🎉 |
| ] | ||
| }, | ||
| { | ||
| "title": "Install providers", |
There was a problem hiding this comment.
What do you think about "Use providers", "Configure providers", etc rather than install? To me, "install" feels like the CLI side of things.
There was a problem hiding this comment.
To me, installing most closely matches the action, but we can try "Configure providers". I was trying to avoid potential confusion in terms of developing providers. IMO, "Use" is almost always way to generic, but it fits in this case better than most.
rkoron007
left a comment
rkoron007
left a comment
There was a problem hiding this comment.
Approving to unblock, but left a few suggestions in our slack thread!
| }, | ||
| { "divider": true }, | ||
| { "heading": "UPGRADE"}, | ||
| { "title": "Overview", "path": "upgrade-guides" }, |
There was a problem hiding this comment.
Just thinking out loud, does the fact that this page is what was previously titled "Upgrade to vX.X", now titled "Overview", lose visibility? I had a little trouble finding it at first, but I was also looking at the current nav side-by-side and was probably pretty biased looking for the exact page name.
There was a problem hiding this comment.
Fair, but I think that the existing title is kind of misleading because the page doesn't really provide any instructions on how to upgrade, which is what I think people would expect. I'll change this back so that we reduce the number of experimental vectors in this PR, but we in the future we need to explore either providing useful instructions or renaming to something more in line with the actual content.
| { "divider": true }, | ||
| { | ||
| "divider": true }, | ||
| { "heading": "REFERENCE" }, |
There was a problem hiding this comment.
This actually hadn't changed in this PR, but how do we decide what's in all caps, and what's int title case? Right now the nav bar headers are:
- Configuration Language
- UPGRADE
- REFERENCE
- Resources
There was a problem hiding this comment.
Good callout. Unless we make changes to the portal repo, I think we're stuck with "Configuration Language" and "Resources", so maybe we should ditch the all caps for the other sections for consistency.
| { | ||
| "title": "Upgrade to Terraform v1.14", | ||
| "path": "upgrade-guides" | ||
| "title": "Extend CRUD operations", |
There was a problem hiding this comment.
This is really the only wording I'm still not sure on since it's a pretty wide net, but I'm not sure I have a better suggestion still. Maybe let's go live with this change but keep an eye on the content traffic in this section?
| "path": "attr-as-blocks", | ||
| "hidden": true | ||
| "title": "Get started", | ||
| "href": "https://developer.hashicorp.com/terraform/tutorials" |
There was a problem hiding this comment.
Should this be a relative link?
There was a problem hiding this comment.
You have to use the full URL to get the arrow icon in the sidebar. I guess it's technically not an external link, but I felt that it's a different enough region of the site that we should use that icon.
Co-authored-by: Robin Norwood <robin.norwood@gmail.com>
4 participants
This PR updates navigation labels for the language docs. We are going to return to a labeling principle based on language construct, instead of JTBD. The second-order principle is to label groups of topics based on workflows. Our North Star principle for creating topics based on information type (Diataxis) is unchanged.
In addition to updating labels and linking to relevant reference pages in the navigation groups, I made sure to cross-link reference pages to usage pages so that people who land on a reference topic from search have an escape hatch to a how-to topic.