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.

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

Publish versioned docs #216

Closed
shawnbot opened this issue Aug 15, 2018 · 4 comments
Closed

Publish versioned docs #216

shawnbot opened this issue Aug 15, 2018 · 4 comments
Labels
💓collab a vibrant hub of collaboration deployment docs Documentation enhancement New feature or request

Comments

@shawnbot
Copy link
Contributor

One thing that I think we should do as part of #38 is to publish docs to versioned URLs that will never change. For instance, if 1.0.1-beta was the latest version:

  • https://primer.github.io/components/v1.0.1-beta/ is created when we publish to npm
  • https://primer.github.io/components/ aliases/redirects to the above URL
  • https://primer.github.io/components/v2.0.0-rc.0/ is published for the first release candidate (cc: Publish release candidates from CI #152) of 2.0.0

@imgonnarelph was looking at the v1 docs this morning and was confused when colors weren't working for him in 0.0.11-beta. It'd be great to publish previous releases to avoid that sort of issue.

@shawnbot shawnbot added the docs Documentation label Aug 16, 2018
@shawnbot shawnbot moved this from Backlog to Ready in Primer Components release tracking 📋 Aug 17, 2018
@emplums emplums moved this from v2.0.1-beta to Backlog in Primer Components release tracking 📋 Aug 20, 2018
@shawnbot

This comment has been minimized.

@shawnbot

This comment has been minimized.

@shawnbot

This comment has been minimized.

@shawnbot shawnbot added 💓collab a vibrant hub of collaboration ⭐️rep an industry leading reputation workflow deployment and removed workflow ⭐️rep an industry leading reputation labels Sep 17, 2018
@shawnbot
Copy link
Contributor Author

Okay, I think I have a better solution for this:

We can set up a deploy stage in our Travis config that only deploys for tags, and would alias the existing deployment from Now's GitHub integration to a versioned subdomain, i.e.:

😎

@emplums emplums added the enhancement New feature or request label Oct 23, 2018
@emplums emplums closed this as completed Jul 22, 2019
Primer Components release tracking 📋 automation moved this from Backlog to Release 12.0.2 Completed Jul 22, 2019
@emplums emplums moved this from Release Completed to 🚢Published in Primer Components release tracking 📋 Jul 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💓collab a vibrant hub of collaboration deployment docs Documentation enhancement New feature or request
Projects
No open projects
Development

No branches or pull requests

2 participants