-
-
Notifications
You must be signed in to change notification settings - Fork 432
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
Allow to link to a specific version of the docs #47
Comments
I wish I have more time to make changes to this book and update it more constantly :) You can always refer to commit SHA in the repository if you need something very persistent. |
I should have mentioned that I already considered commit hashes but I found them unusable with GitBook because it really needs to be rendered. Example: https://github.com/antonbabenko/terraform-best-practices/blob/f8650d231ec7ac5b2f957ec78f079776c97fb42b/naming.md It just looks very broken when you see unrendered template code like that. Can you reopen? Maybe someone has a nice idea. I am fine with commit hashes on https://www.terraform-best-practices.com/ |
I can reopen it, but I don't think it is currently possible to achieve using gitbook platform. |
Is your feature request related to a problem? Please describe.
When an organization defines the (coding) style that should be followed, it comes in handy to just reference a few URLs and say we adhere to this and done. However, this external resource can change.
Describe the solution you'd like
The version of the docs should be selectable and pinable. I am not familiar with GitBook. https://docs.jabref.org/ top right version selector would be a start.
Additionally, the project would need to start doing releases following some like https://semver.org/spec/v2.0.0.html. Or at least have stable branches like stable-2.0, stable-2.1.
Note that https://semver.org/ has exactly the same requirement so they offer URLs like https://semver.org/spec/v2.0.0.html to pin the version.
Another solution could be to mirror https://github.com/antonbabenko/terraform-best-practices, render the docs and then point to this fixed version. Then git can be used to update and diff changes.
The text was updated successfully, but these errors were encountered: