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

Improve CDN listing page(s) #354

Open
james-nash opened this issue Sep 25, 2019 · 0 comments
Open

Improve CDN listing page(s) #354

james-nash opened this issue Sep 25, 2019 · 0 comments
Labels
💡 idea TYPE: Indicates that this is an idea. These may end up spinning out into a separate projects. docs CATEGORY: Anything related to documentation infrastructure CATEGORY: Infrastructure related - e.g. updates to build process, tests, tooling, etc.

Comments

@james-nash
Copy link

Is your feature request related to a problem? Please describe.
Copies of new gravity-ui-web releases get uploaded to our CDN here: https://static.buildit.digital/gravity-ui-web/

The index page you see at the URL is very basic, so it might be nice to spruce it up a bit. Specifically, things that would be nice are:

  • More details for each release
    • Currently we just list out the version number. It would be good if we included direct links to the actual files in each Gravity release (e.g. gravity.css, gravity.js etc.), since that's what people using the CND will ultimately be after. This could be a little list of filenames (each of which is a link to the corresponding file) OR we could add an index page for each release with that file listing and then link to that. (The latter option might help the main index page from becoming excessively long)
    • A link to the corresponding NPM package version on npmjs.com
    • A link to that versions release notes on Github
  • A page header
    • Something to give visitors some context. I.e. what is this page for?
  • A page footer
    • Provide some links back to the main Buildit website and Gravity pattern library

Describe the solution you'd like

  1. Make some lo-fi mockups to explore the above ideas. Pen & paper would do. Maybe a CodePen or two if you're feeling adventurous. Share on the #buildit-gravity Slack channel for feedback from the rest of the team
  2. Update cdn-index.template and scripts/cdn_publish.sh as necessary. My hunch is that we may need replace or augement them with something a little more sophisticated. Using a bash script to string together bits of HTML is a bit clunky. Maybe a little Node.js script would be easier? Potentially it could even make use of some of the Nunjucks templates we have within gravity-ui-nunjucks?
@james-nash james-nash added docs CATEGORY: Anything related to documentation infrastructure CATEGORY: Infrastructure related - e.g. updates to build process, tests, tooling, etc. 💡 idea TYPE: Indicates that this is an idea. These may end up spinning out into a separate projects. labels Sep 25, 2019
@james-nash james-nash added this to the Gravity NEXT milestone Sep 25, 2019
@c1rrus c1rrus removed this from the Gravity NEXT milestone Jan 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 idea TYPE: Indicates that this is an idea. These may end up spinning out into a separate projects. docs CATEGORY: Anything related to documentation infrastructure CATEGORY: Infrastructure related - e.g. updates to build process, tests, tooling, etc.
Projects
None yet
Development

No branches or pull requests

2 participants