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.

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

Updating Sidebar to Match Design Spec #1048

Merged
merged 3 commits into from
Sep 6, 2022

Conversation

laurapacilio
Copy link
Contributor

@laurapacilio laurapacilio commented Sep 2, 2022

The DevDot process flagged two issues with the sidebar:

  • The logging pages that are actually links to an entire other docs section (but this isn't necessarily obvious to users before they click them)
  • The link to learn tutorials. We don't need this anymore! tutorials will be integrated into devdot.

This PR removes the learn link and limits the logging section to one pointer page and the page about HTTP transport. These pages DO exist in this documentation set but then points users to the external logging documentation set. I think this is a happy medium that will get users where they need to go, let them know logging stuff exists, but not provide unexpected links to another doc set.

New Sidebar

Screen Shot 2022-09-02 at 4 33 21 PM

Copy link

@zchsh zchsh left a comment

Choose a reason for hiding this comment

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

✅ This looks great to me! 👍 Mostly looking at JSON formatting, since I don't have any strong opinions on the content & design side ☺️

@laurapacilio laurapacilio merged commit 1a8df1a into dev-portal Sep 6, 2022
@laurapacilio laurapacilio deleted the fix-sdkv2-sidebar-devdot branch September 6, 2022 17:37
bflad pushed a commit that referenced this pull request Sep 16, 2022
* Docs Changes for DevDot Migration (#1036)

* Remove mentions of HashiCorp Learn

* Remaining updates - terraform.io, mentions of docs nav

* Update website/docs/plugin/sdkv2/resources/import.mdx

Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>

* Update website/docs/plugin/sdkv2/testing/index.mdx

Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>

* Update website/docs/plugin/sdkv2/testing/acceptance-tests/index.mdx

Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>

* Update website/docs/plugin/sdkv2/best-practices/index.mdx

Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>

* Update website/docs/plugin/sdkv2/guides/v2-upgrade-guide.mdx

Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>

* Update website/docs/plugin/sdkv2/resources/index.mdx

Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>

* Update website/docs/plugin/sdkv2/testing/index.mdx

Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>

Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>

* Updating Sidebar to Match Design Spec (#1048)

* Updating Sidebar to Match Design Spec

* Update website/data/plugin-sdk-nav-data.json

* Update website/data/plugin-sdk-nav-data.json

* Update index.mdx (#1053)

* Update index.mdx

* Update website/docs/plugin/sdkv2/index.mdx

Co-authored-by: Matthew Garrell <69917312+mgarrell777@users.noreply.github.com>
@github-actions
Copy link

github-actions bot commented Oct 7, 2022

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants