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.

Sign up for GitHub

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

Jump to bottom

Add Typedoc static site #12

Merged
merged 9 commits into from
Apr 20, 2020
Merged

Add Typedoc static site #12

merged 9 commits into from
Apr 20, 2020

Conversation

eessex
Copy link
Contributor

@eessex eessex commented Apr 16, 2020 •
edited by artsyit

  • Adds typedoc lib
  • Updates comments to render nicely in Typedocs
  • Compiles docs & uploads to S3 on publish

Docs site: https://artsy-static-sites.s3.amazonaws.com/artsy-cohesion/index.html

TODO:

  • Setup AWS bucket / policy to store site
  • Update CI config to publish docs on merges to master
  • Point DNS to static site

Screen Shot 2020-04-16 at 1 37 15 PM

📦 Published PR as canary version: 0.2.0-canary.12.285.0

✨ Test out this PR locally via:

npm install @artsy/cohesion@0.2.0-canary.12.285.0
# or 
yarn add @artsy/cohesion@0.2.0-canary.12.285.0

@eessex eessex self-assigned this Apr 16, 2020
@eessex eessex requested a review from zephraph April 16, 2020 17:46
@eessex eessex requested a review from abhitip April 16, 2020 21:28
@eessex eessex force-pushed the typedoc branch 11 times, most recently from 4516abe to f073a9c Compare April 20, 2020 20:35
@zephraph
Copy link
Contributor

There's a .DS_Store file on the PR. Might want to remove that.

@zephraph
Copy link
Contributor

Looks great @eessex! Mind flipping it over to ready for review?

@eessex eessex marked this pull request as ready for review April 20, 2020 20:57
@eessex eessex changed the title [WIP] Add Typedoc static site Add Typedoc static site Apr 20, 2020
@eessex eessex assigned zephraph and unassigned eessex Apr 20, 2020
@eessex eessex removed the request for review from zephraph April 20, 2020 20:59
zephraph
zephraph approved these changes Apr 20, 2020
View reviewed changes
Copy link
Contributor

@zephraph zephraph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @eessex! I don't know what I'm excited about more, the docs or the doc uploading process. 😄

@zephraph zephraph added Version: Patch A deploy for bug fixes or minor changes Version: Trivial and removed Version: Patch A deploy for bug fixes or minor changes labels Apr 20, 2020
@zephraph zephraph merged commit a40c776 into master Apr 20, 2020
@zephraph zephraph deleted the typedoc branch April 20, 2020 21:14
@artsyit
Copy link
Collaborator

artsyit commented Apr 20, 2020

🚀 PR was released in v0.1.2 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zephraph zephraph zephraph approved these changes

@abhitip abhitip Awaiting requested review from abhitip

Assignees

@zephraph zephraph

Labels
released Version: Trivial
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@eessex @zephraph @artsyit