website: resolve unlinked content #11391
Conversation
| @@ -0,0 +1,148 @@ | |||
| var fs = require("fs"); | |||
There was a problem hiding this comment.
I've added this check as a bit of a hotfix as well. Happy to remove if we feel like we're better off without it - I suspect we'll ultimately want to perform this check in docs-page (similar to what we do with validateFilePaths).
|
|
||
| /** | ||
| * DEBT | ||
| * This is a short term hotfix for "hidden" docs-sidenav items. |
There was a problem hiding this comment.
Hopefully this comment covers the context here - once we come up with an alternate solution (eg a modification to docs-page/server.js or to docs-sidenav or something), I think this will be relatively straightforward to switch back out.
With that in mind, I think this same solution can be applied to other sites where unlinked content is an issue.
| @@ -0,0 +1,20 @@ | |||
| [ | |||
There was a problem hiding this comment.
The api-docs and docs routes seemed appropriate to continue to keep hidden, to match previous behaviour. I've used the _temp-enable-hidden-pages fix to allow this.
Idea here is it'll be easy to keep track of "hidden" pages during this temporary fix stage, since they're in a separate nav-data.json file. And easy to move into the proper "visible" nav-data.json file if any of these pages should actually be visible in the sidebar.
| }, | ||
| { | ||
| "title": "Performance Standby Nodes", | ||
| "path": "operations/performance-nodes" |
There was a problem hiding this comment.
/guides is already hidden / unlinked from main navigation, so rather than add another layer of complexity here, I've just added the missing pages.
Should note as well that all these paths redirect to Learn anyways. But felt that the deletion of guides content probably merits a separate PR, and should probably be done all at once for clarity.
| .g-docs-sidenav { | ||
| --brand: var(--vagrant) !important; | ||
| --brand-text: var(--vagrant) !important; | ||
| } |
There was a problem hiding this comment.
This is very similar to the override above - we're in a bit of a transient branding stage, and with Vault specifically the --brand colors actually cause quite a few issues. There is a "debt" comment just above here that I'm rolling this change into.
In this specific case, the --brand value for vault is gray by default, so "active" sidebar items, which should appear highlighted, are really hard to pick out.
This change is kind of unrelated to the "unlinked pages" issue; I've added it in because it felt important to patch for UX purposes.
This PR fixes an issue where pages that were previously not included in
*-nav-data.jsonfiles were not rendered.This PR introduces a temporary fix to ensure these pages are rendered, but are not shown in the sidebar navigation, to match previous behaviour. We plan to revisit this issue more intentionally in the near future, once the Vault branding PR lands.
This PR also introduces a hotfix for brand-related link coloration issues in
docs-sidenav. On the live site, the "active" sidebar item is not clearly highlighted; with this fix in place, we use our brand blue color to ensure the highlight is visible (and to match a similar hotfix, seestyle.cssfor details).Affected Pages
apidocs/docs/commands/path-help, we likely just want to delete thewebsite/content/docs/commands/help.mdxfile./docs/secrets/databases/cassandra, we likely just want to delete thewebsite/content/docs/secrets/cassandra.mdxfile.guides