-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
π enhancementTYPE: Indicates new feature requestsTYPE: Indicates new feature requestsdocsCATEGORY: Anything related to documentationCATEGORY: Anything related to documentationhelp wantedINVITATION: Indicates that a maintainer wants help on an issue or pull requestINVITATION: Indicates that a maintainer wants help on an issue or pull requestinfrastructureCATEGORY: Infrastructure related - e.g. updates to build process, tests, tooling, etc.CATEGORY: Infrastructure related - e.g. updates to build process, tests, tooling, etc.
Description
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
- 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 docshttp://style-next.buildit.digital/patterns/: Pattern libraryhttp://style-next.buildit.digital/sassdoc/: SASS docs
- Alternatively, setup a dedicated subdomain (and associated S3 bucket). E.g.
gravity-sassdocs.buildit.digital/?
- Perhaps the easiest thing would be to piggy-back on the existing
- 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. - Update
.travis.ymlto:- Run
npm run docs(and possibly alsonpm run docs:dev) - Upload the output from
dist/docs/sass/(and possibly alsodist/docs/sass-dev/) to the appropriate location on Amazon S3
- Run
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
π enhancementTYPE: Indicates new feature requestsTYPE: Indicates new feature requestsdocsCATEGORY: Anything related to documentationCATEGORY: Anything related to documentationhelp wantedINVITATION: Indicates that a maintainer wants help on an issue or pull requestINVITATION: Indicates that a maintainer wants help on an issue or pull requestinfrastructureCATEGORY: Infrastructure related - e.g. updates to build process, tests, tooling, etc.CATEGORY: Infrastructure related - e.g. updates to build process, tests, tooling, etc.