(ARCHIVED) Revamp: Final Gridsome Hub Burndown List

[alexmarple]

EDIT (@aaronsteers):

I've locked this issue in favor of moving all items to the Milestones:

• MVP Launch Milestone
• Day 2 Changes Milestone

---

This is the final burndown list for the Gridsome refresh of the Hub. As of Wednesday 8/31, all of the due for release items are currently in process and should be finished by EOW for final release. The items in the fast follow should be available for release within one to two weeks.

Due for release:

• Singer pages (PR)
• Maintainer page
• Search bar bug
• Add --variant flag to template sidebar code ~~(PR) fix: use --variant CLI option in sidebar install instructions #774
• Final design sweep
  • Mobile nav fix
  • Sidebar breakpoint bug
  • Fix spacing issue on template page
• Only show default variant on plugin index pages
• Add Commands to templates (PR)
• Redirects for variant template pages (the old plugin--variant as opposed to the new plugin/variant)

Fast follow:

• Componentize template sections for better readability
• Add variant metrics to template sidebar
• Maintainers page will link to dynamic search (e.g. https://hub.meltano.com/search?maintainer=meltanolabs)
• Add 404 page for when searching for a plugin and it does not exist that directs people to make a plugin
• Add number of plugins to nav dropdown

[tayloramurphy]

@aaronsteers @alexmarple Things I notice not in the burndown:

• https://meltano-hub-gridsome.netlify.app/extractors/tap-auth0/ the settings aren't listed beyond what's in settings_group_validation https://hub.meltano.com/extractors/tap-auth0#settings
• The default pages link to the URL with the variant in the path (i.e. https://meltano-hub-gridsome.netlify.app/extractors/tap-auth0/matatika/) when it should be (https://meltano-hub-gridsome.netlify.app/extractors/tap-auth0/)
• Utilities aren't showing the additional metadata and are showing wrong next step instructions. https://meltano-hub-gridsome.netlify.app/utilities/superset/apache/ has instructions for a tap. compare to https://hub.meltano.com/utilities/superset which has specific next steps and dependencies
• I'm assuming Singer pages means rendering the markdown on a page like https://meltano-hub-gridsome.netlify.app/singer/spec and updating https://meltano-hub-gridsome.netlify.app/singer/ ?

Minor

• minor: I'm seeing a weird bug when I search from a variant page and then click on the dropdown, the URL changes but the content doesn't.
• minor: the github stars header just shows "Star"

[alexmarple]

@tayloramurphy thanks for these!

• There is a settings addition PR that also adds commands, utilities, and a few other items
• I'll look at the page path issue with variants
• That's correct about the singer pages
• AJ found that search bar bug. I'm working on a fix right now.
• I just saw the GitHub star bug. That's strange. I'll look to see if I implemented that wrongly or rightly. For now I might just remove it and add it to the fast follow list.

[tayloramurphy]

@alexmarple sounds good - tag me on the PR please for an additional set of eyes.

[aaronsteers]

Notes from walkthrough today (Friday) with @tayloramurphy:

1. Search results should link to page w/o the variant suffix, if it's the default variant.
2. Same as 👆 for index pages.
3. Index pages should suppress non-default variants.
4. "Next Steps" section of the detail pages:
   1. Extractor, Loaders, and Transformers each have different static content.
   2. For everything else (Utilities, etc.) should print the section only if next_steps is in Markdown.
      1. Plugin detail page should render the markdown from yaml: settings_preamble, definition, next_steps, prereq.
      2. e.g. Superset (et al) should render its custom "Next Steps" from yaml markdown entry.
      3. e.g Files should not have next_steps so they should not have that section.

[aaronsteers]

@alexmarple - I can take items 1-3 above but I'll be blocked on 4.ii (markdown).

If you have a code snippet for markdown rending, I could also take that one.

🥷 edit:

• Logged this for the markdown rendering solve and assigned to you, @alexmarple : feat(gridsome): support for markdown rendering from **yaml/graphQL page content** #765

[aaronsteers]

Note on the above. All of the items mentioned in my comment are done now except:

• fix(gridsome): Update "Next Steps" section to be correct for each plugin and plugin type #778