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 for documentation versioning #270
Comments
I really want to get this out but there are two hurdles I see:
|
Would it be crazy to simply add a version directory inside |
Hmmm I think it would only be slightly crazy; that could grow to be a lot of baggage (images, etc.) over time and really clog up the repo. But at this exact moment, especially if we just want this ability sooner rather than later, that is totally reasonable in my book. |
I have zero expertise in this so it's probably safe to ignore me :) We can always use git to retrieve the historical docs, so any decision is reversible. |
I would support API doc versioning because it seems like the most frequently changed among the suite. However if features used in tutorials change in breaking ways then those too will need to be updated. |
Right - updating is one thing, but actually keeping all previous versions of tutorials is another |
Hmm good point. How hard is it to enable full support for documentation versioning? If we went with full documentation versioning (not just API) we could provide some mechanism where a |
There are two issues with doing full versioning:
|
Ok so I stand by my claim that it would be "easy" but very messy --> the |
@dylanbhughes do you have any ideas about the best way to do API doc-versioning in vuepress? |
I just revisited this and it will also require us to maintain a sidebar in our master |
@jlowin suggested a possible route forward here: store all the necessary artifacts / files in an appropriate subdirectory of |
Relevant but not necessary for us to do this ourselves: vuejs/vuepress#857
The text was updated successfully, but these errors were encountered: