Skip to content

Docs releases #522

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

Merged
merged 6 commits into from
Dec 3, 2017
Merged

Docs releases #522

merged 6 commits into from
Dec 3, 2017

Conversation

flovilmart
Copy link
Contributor

@flovilmart flovilmart commented Dec 3, 2017

  • Adds docs for cloud code methods (original methods, still missing beforeFind)
  • Adds automated deployment of docs to gh-pages with preservation of current branch.
  • Adds tagged deployment of the SDK automatically to npm.
  • Adds tagged deployment of docs in folder in docs.
  • Improve performance of travis-ci by enabling npm caching
  • Use minami template for docs rendering, nicer, probably more flexible.

@codecov
Copy link

codecov bot commented Dec 3, 2017

Codecov Report

Merging #522 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #522   +/-   ##
=======================================
  Coverage   84.59%   84.59%           
=======================================
  Files          48       48           
  Lines        3952     3952           
  Branches      897      897           
=======================================
  Hits         3343     3343           
  Misses        609      609

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2e11780...f8426c8. Read the comment docs.

local_dir: docs/
on:
all_branches: true
- provider: npm
Copy link
Contributor

Choose a reason for hiding this comment

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

Me Gusta! Awesome that this would cut out a step we would have to do by hand 👍 .

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes! Figured we should do as much as we could!

then
DEST="${TRAVIS_TAG}"
# change the default page to the latest
echo "<meta http-equiv='refresh' content='0; url=/Parse-SDK-JS/api/${DEST}'>" > "docs/api/index.html"
Copy link
Contributor

Choose a reason for hiding this comment

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

This is interesting... So per release we're just redirecting via meta to the latest set? That's kind of cool actually. One thing I'm curious about is if we're maintaining an index or a table of contents for existing doc versions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So far we don’t, but with this strategy we’ll be able to :)

Copy link
Contributor

@montymxb montymxb left a comment

Choose a reason for hiding this comment

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

Nice. I'll defer to the results of the CI.

@flovilmart
Copy link
Contributor Author

flovilmart commented Dec 3, 2017

Ci passes! Once merged this should put the master doc set in gh pages, I did extensive testing on my repo :) https://travis-ci.org/flovilmart/Parse-SDK-JS/branches

@flovilmart flovilmart merged commit 692b3d5 into master Dec 3, 2017
@flovilmart flovilmart deleted the docs-releases branch December 3, 2017 04:40
@flovilmart
Copy link
Contributor Author

@flovilmart
Copy link
Contributor Author

@montymxb
Copy link
Contributor

montymxb commented Dec 3, 2017

Now that's a sight to see 🍻 .

@flovilmart
Copy link
Contributor Author

Took a few weekends to get there, next is all iOS repos! We can later customize the theme/template if we have time, to make it more parse-like . There's docstrap that offers a nice template, more customizable, and with more fluid navigation.

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.

2 participants