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

Support multiple versions of Blaze documentation on our site #77

Closed
mitar opened this issue Sep 2, 2016 · 10 comments
Closed

Support multiple versions of Blaze documentation on our site #77

mitar opened this issue Sep 2, 2016 · 10 comments

Comments

@mitar
Copy link
Contributor

mitar commented Sep 2, 2016

So we should make the site/docs describe current version of Blaze. But as we will be adding more and more features to Blaze it would be great if users could navigate to old versions of documentation as well.

@mitar mitar added this to the Next steps milestone Sep 2, 2016
@alexandesigner
Copy link
Contributor

Currently on the site it is possible to navigate by version See (as it is done in the Meteor Docs, as well as the search too, just need to better understand how exactly work this versioning on site..

I speak with regard to content, how to organize it?

@mitar
Copy link
Contributor Author

mitar commented Sep 9, 2016

@stubailo, @tmeasday: How is that versioning working?

I think we should track it based on Blaze package version. Other packages are mostly dependencies. And we can also in the worst case bump Blaze package version if some other package has a large change which has to be documented well.

@tmeasday
Copy link
Contributor

tmeasday commented Sep 9, 2016

It works like:

  1. Create a branch called versionX, this will automatically deploy to http://blazejs.org/vX (I think?)
  2. Add values to the versions field of _config.yml (here). When you have more than one the version picker will appear.

@mitar
Copy link
Contributor Author

mitar commented Sep 9, 2016

Oh, hm. Currently on every master branch change only, the site is deployed to gh-pages. Not sure about any branches.

I do not find any documentation about these versions config?

@tmeasday
Copy link
Contributor

tmeasday commented Sep 9, 2016

Oh, right i forgot you weren't deploying to s3.

Well it'll work if you switch to using that. Otherwise I guess you can try and figure out a similar solution.

@mitar
Copy link
Contributor Author

mitar commented Sep 9, 2016

Hm, but even with S3, where you have code which is deploying those branches? And where you configure that logic? GitHub hooks? CircleCI?

@mitar
Copy link
Contributor Author

mitar commented Sep 9, 2016

OK, we are now deploying to S3 to a bucket hosted by MDG (blazejs.org.s3-website-us-east-1.amazonaws.com). I had to configure CNAME for top-level domain (blazejs.org) because Namecheap does not support ALIAS or ANAME DNS entries. This is bad practice and could prevent e-mail to work for our domain, but because we are not really using e-mails, I think it is good enough for now.

I removed GitHub pages.

This allows us now to use the same script and approach Meteor is using for their versions. That is, every release we want to have documentation for, we create a version-* branch.

@mitar
Copy link
Contributor Author

mitar commented Sep 9, 2016

OK, we have now support for this deployed.

@mitar mitar closed this as completed Sep 9, 2016
@alexandesigner
Copy link
Contributor

Very good @mitar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants