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

Publish SASS API docs #353

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

Publish SASS API docs #353

james-nash opened this issue Sep 25, 2019 · 0 comments
Labels
docs CATEGORY: Anything related to documentation help wanted INVITATION: Indicates that a maintainer wants help on an issue or pull request infrastructure CATEGORY: Infrastructure related - e.g. updates to build process, tests, tooling, etc. 🌟 enhancement TYPE: Indicates new feature requests

Comments

@james-nash
Copy link

james-nash commented Sep 25, 2019

Is your feature request related to a problem? Please describe.
We added SASS docs to gravity-ui-web recently. However, the only way to see them is to check out the code, build the docs locally and open them in your browser. We don't currently publish them on the web, but we should. :-)

Describe the solution you'd like

  1. Decide what the URL(s) should be.
    • Perhaps the easiest thing would be to piggy-back on the existing http://style[-*].buildit.digital/ domain where the pattern library lives and just add a directory. E.g. http://style-next.buildit.digital/sassdoc/
    • A variation on the above would be to also move the pattern library into a sub-folder and add a simple landing page that links to both:
      • http://style-next.buildit.digital/: Simple landing page with links to pattern library & SASS docs
      • http://style-next.buildit.digital/patterns/: Pattern library
      • http://style-next.buildit.digital/sassdoc/: SASS docs
    • Alternatively, setup a dedicated subdomain (and associated S3 bucket). E.g. gravity-sassdocs.buildit.digital/?
  2. Decide whether we should also publish a dev build of the SASS docs (which includes internal APIs). So, we might have both .../sassdoc/ and .../sassdoc-dev/ or similar.
  3. Update .travis.yml to:
    • Run npm run docs (and possibly also npm run docs:dev)
    • Upload the output from dist/docs/sass/ (and possibly also dist/docs/sass-dev/) to the appropriate location on Amazon S3
@james-nash james-nash added 🌟 enhancement TYPE: Indicates new feature requests help wanted INVITATION: Indicates that a maintainer wants help on an issue or pull request infrastructure CATEGORY: Infrastructure related - e.g. updates to build process, tests, tooling, etc. labels Sep 25, 2019
@james-nash james-nash added this to the Gravity NEXT milestone Sep 25, 2019
@james-nash james-nash added the docs CATEGORY: Anything related to documentation label Sep 25, 2019
@james-nash james-nash removed this from the Gravity NEXT milestone Mar 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs CATEGORY: Anything related to documentation help wanted INVITATION: Indicates that a maintainer wants help on an issue or pull request infrastructure CATEGORY: Infrastructure related - e.g. updates to build process, tests, tooling, etc. 🌟 enhancement TYPE: Indicates new feature requests
Projects
None yet
Development

No branches or pull requests

1 participant