Sidebar Navigation for Reference Pages

[zstix]

Descriptions

Updates the reference page template to query GraphQL for markdown files. Once we have the data from Gatsby, we convert it to a format that our UI can use to build out a nested set of links.

The heavy lifting for this work is done in src/utils/nav-from-edges.js, so I added a bunch of documentation explaining what's going on. I also added a couple dummy markdown pages to help test that everything is working.

Note: in the future we should update the GraphQL query to only get files using the reference template (this gets all markdown files for now). Also, we are simply sorting alphabetically by displayName at the moment.

Preview Link(s)

• https://pr-50.dlyi50rq9kt6c.amplifyapp.com/reference/

Related Ticket(s)

• DEVEX-610

Screenshot(s)

[timglaser]

This is a good case for a unit test on getNavFromEdges.

And I'm running into what might just call for a readme documentation in this project along the lines of "how to manage paths." I notice the presence of an /a/b path value keeps an /a/b/c path value from showing up as A => B => C in the nav even if an /a/b/index is present. I think writing out at least a draft documentation for this now will help solidify that this is feeling right.

[zstix]

Totally agree about the tests and about the documentation.

Also, it turns out that Gatsby doesn't treat paths that end with index as I would expect. Gatsby does not build a page like guides/index into developers.newrelic.com/guides. That might require a sizable refactor to this algorithm.

Probably something best done after we have some tests defining how we want it to function.

[zstix]

I've updated this PR to include a test to ensure that the utility function is running correctly. This also helped me refactor the link generation to resolve how we were creating "index" pages. Ready for a re-review!

[timglaser]

Awesome work on this. Is the intention for this PR to support the following?

path 1: /a
path 2: /a/b1
path 2: /a/b2
path 3: /a/b1/c1
path 4: /a/b1/c2

I don't want to go overkill in testing/reviewing this if the existing test case in the test file is all we need at this moment for initial content creation.

[zstix]

@timglaser I believe that this test covers all of those scenarios. I'm happy to add more tests if we would like...was just trying to keep this moving.

[LizBaker]

🔗

[nr-opensource-bot]

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀