Skip to content

Conversation

@zstix
Copy link
Contributor

@zstix zstix commented Aug 30, 2021

Description

Does what it says on the tin.

Of note, we previously had documentation for this stuff but it was recently removed.

Screenshot(s)

Screen Shot 2021-08-30 at 10 46 16

This was partially documented in our style guide, but was removed in
this pull request:

#3670
@zuluecho9
Copy link
Contributor

zuluecho9 commented Aug 30, 2021

@zstix that internal how to doc wasn't removed; we just created a new longer doc for it fyi. But realized I didn't add redirect for that, will do that.

@zuluecho9 zuluecho9 self-assigned this Aug 30, 2021
@mmfred
Copy link
Contributor

mmfred commented Aug 30, 2021

@zuluecho9 - are you saying this PR is not needed? Unsure what to do with this.

@zstix
Copy link
Contributor Author

zstix commented Aug 30, 2021

@zuluecho9 I hate to disagree, but the content that was in that document does not exist in the repository anymore. For example, we used to have a section called "Add a new top-level nav" that no longer exists: https://github.com/newrelic/docs-website/search?q=Add+a+new+top-level+nav

Same with Use nav YAML to populate page menus, Nav Requirements, etc.

@zuluecho9
Copy link
Contributor

@zstix Yes, it was dramatically restructured, mainly because the team was having trouble with it so we wanted to make it more usable for everyone. So that now that content lives in a new section here: https://docs.newrelic.com/docs/style-guide/processes-procedures/understand-edit-docs-site-structure/#add-nav-section

I"m curious, too: what was your goal in wanting the category view for 'Observe everything'? Was it just to make it parallel with other categories? Or was there a problem/use case you were seeing for wanting that?

@zstix
Copy link
Contributor Author

zstix commented Aug 30, 2021

@zuluecho9 At the moment, this page is blank: https://docs.newrelic.com/docs/full-stack-observability/observe-everything/

I figured that we would prefer to have some links generated to align it with how the rest of the site handles it. If this isn't desired, feel free to close out the PR!

@zuluecho9
Copy link
Contributor

zuluecho9 commented Aug 30, 2021

no that makes sense @zstix. Gonna approve it now. I was just curious if it was just something you noticed or if it was from a complaint or what. Thanks. I didn't state that clearly, sorry.

@zuluecho9 zuluecho9 self-requested a review August 30, 2021 18:13
@zuluecho9 zuluecho9 added content requests related to docs site content from_external Identifies issues/PRs from non-Relics labels Aug 30, 2021
@zuluecho9 zuluecho9 merged commit 8412516 into develop Aug 30, 2021
@zuluecho9 zuluecho9 deleted the zstix/add-missing-index-page branch August 30, 2021 18:13
@zstix
Copy link
Contributor Author

zstix commented Aug 30, 2021

@zuluecho9 Yeah, I noticed the issue.

I do want to point out (and I apologize for being a stickler about this) that the reason this page is blank is because of a requirement that we had previously had documented that is no longer in the consolidated style guide:

When creating the page we look through each nav YAML file for a reference to the path to know which nav data to use for the left nav and the auto index page content.

@zuluecho9
Copy link
Contributor

zuluecho9 commented Aug 30, 2021

@zstix Some of the 'how it works' was moved up into the more conceptual/philosophical section at top: https://docs.newrelic.com/docs/style-guide/processes-procedures/understand-edit-docs-site-structure/#doc-sidebar and this section: https://docs.newrelic.com/docs/style-guide/processes-procedures/understand-edit-docs-site-structure/#category-view I'll add a link or two from the 'create nav file' section to that 'how it works' section though.

@austin-schaefer austin-schaefer added from_internal Identifies issues/PRs from Relics (except writers) and removed from_external Identifies issues/PRs from non-Relics labels Sep 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants