-
Notifications
You must be signed in to change notification settings - Fork 701
Add react-static content for deploying docs #786
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
Conversation
|
There are a lot of references to the JS + MDX Spectacle boilerplate projects, but I think it's easier to wait until after this lands and then I'll hop in and update all the references to point to |
|
I would also add a todo for adding a CI step to deploy the docs to surge staging on PR so you can check them out before merging to master |
| ) => | ||
| // eslint-disable-next-line promise/avoid-new | ||
| new Promise(resolve => { | ||
| if (fs.existsSync(mdPath)) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NIT: Can just make this internal function async and switch to fs.exists or if we're on a node that has deprecated it, we should add this simple util:
const { promisify } = require("util");
const fs = require("fs");
const stat = promisify(fs.stat);
const exists = (filePath) => stat(filePath)
.then(() => true)
.catch((err) => {
if (err.code === "ENOENT") { return false; }
throw err;
});
ryan-roemer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work! Feel free to ticket as appropriate for later for my existing comments.
* Update deck.js (#686) * Bump handlebars from 4.0.12 to 4.1.2 (#684) * Clear setInterval in cWU * Add test for clearInterval * Update one-page.html to use spectacle 5 (#687) * update one-page.html to use spectacle 5 - fixes CSSStyleDeclaration index property setter error * remove markdown tabbing to render properly * undo ridiculous indentation from prettier * update README to use Spectacle 5 * Minor dependency updates (#701) * Add contentWidth and contentHeight to DeckProps (#699) * Add bulletStyle types, doc updates (#703) * Add bulletStyle types * Fix ListProps type * Add new COC contact email * 5.6.0 * 5.7.0 * Fix transitionDuration prop for Slide component (#690) * Add Spectacle Codemirror extension (#696) * Update dependencies (#706) * 5.7.1 * Document creating slide templates (#733) * Use th for TableHeader (#744) * add deck option to disable touch events (#745) * fix 'inconsistency' spelling in README (#772) * 5.7.2 * Sync spectacle-docs with main repo (#783) * Copy & paste from spectacle-docs * Move README content to docs & gut redundant blocks * Readme++ * migrating from legacy GH services on to GH apps on travis (#785) * Fix dead readme links (#784) * Add react-static content for deploying docs (#786) * Bump axios from 0.16.2 to 0.19.1 in /docs (#790) * Make lint happy * Infra (CI/CD): Do dry run (fake) deployment to testing subdirectory in formidable.com bucket. (#791) * Change deploy.script to single line. (#795) * Infra: Do real deploy to temp directory. (#796) * Infra: Deploy to prod. Fix slug generation and numbers. (#797) Co-authored-by: Kenzo <kenzoikeizume@hotmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Narin Luangrath <narin.luangrath@gmail.com> Co-authored-by: Dominic C <domwork@live.com> Co-authored-by: Max Cantor <i@cantor.mx> Co-authored-by: Jonathan Fielding <jonathan-fielding@users.noreply.github.com> Co-authored-by: Simon Fish <si@mon.fish> Co-authored-by: Adam Gyulavari <azeroths@gmail.com> Co-authored-by: Ilham Wahabi <wahabiputra@gmail.com> Co-authored-by: Carlos Kelly <me@carlos.dev> Co-authored-by: boygirl <lauren.eastridge@formidable.com> Co-authored-by: Erik Thorelli <ethorelli@gmail.com> Co-authored-by: Ryan Roemer <ryan.roemer@formidable.com>
Description
This PR moves to deprecate spectacle-docs so that our docs are maintained and deployed from the main repo.
I'm more than confident I've overlooked something in this migration, so a second/third/fourth set of eyes will be very appreciated.
Closes #782
Type of Change
requiresis a documentation updateNext Steps
docsbuild to an aws bucket to then serve up on the formidable.com site