Skip to content

Conversation

@kale-stew
Copy link
Contributor

@kale-stew kale-stew commented Jan 6, 2020

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

  • New feature (non-breaking change which adds functionality)
  • This change requires is a documentation update

Next Steps

  • Add a CI step to deploy the docs build to an aws bucket to then serve up on the formidable.com site

@ryan-roemer
Copy link
Member

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 spectacle-cli with instructions. I've captured this here: #788

@boygirl
Copy link
Contributor

boygirl commented Jan 7, 2020

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)) {
Copy link
Member

@ryan-roemer ryan-roemer Jan 8, 2020

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;
  });

Copy link
Member

@ryan-roemer ryan-roemer left a 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.

@kale-stew kale-stew merged commit 4de310c into master Jan 8, 2020
@kale-stew kale-stew deleted the task/move-docs branch January 8, 2020 22:35
kale-stew pushed a commit that referenced this pull request Jan 10, 2020
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deploy docs from this repo, deprecate spectacle-docs

5 participants