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

Docs Versioning: Add 2.2.0 stable and 2.3.0-SNAPSHOT #619

Closed
ThomDietrich opened this issue Jan 7, 2018 · 10 comments
Closed

Docs Versioning: Add 2.2.0 stable and 2.3.0-SNAPSHOT #619

ThomDietrich opened this issue Jan 7, 2018 · 10 comments

Comments

@ThomDietrich
Copy link
Member

After the openHAB 2.2.0 release and last improvements and corrections to the documentation it is time to update the versioning function (#520)

@kaikreuzer
Copy link
Member

I just noticed something that I didn't had a close enough look at before: I see that you have created 2.1.0, 2.2.0, 2.3.0 etc. versions.
As I briefly mentioned in #520 (comment), I would actually rather suggest to only have docs for minor versions, i.e. 2.1, 2.2, etc.

Note that we have the addons download site also only for 2.x and if there is a patch release, it will replace the older patch level. We should imho do the same with the documentation as we otherwise might get into too many identical copies of the docs (assuming that patches only contain critical fixes and thus do not really have any impact on the documentation content).

@ThomDietrich ThomDietrich reopened this Jan 7, 2018
@ThomDietrich
Copy link
Member Author

Caught me in the last second. Good point. On it.

@ThomDietrich
Copy link
Member Author

grafik

So you would prefer v2.3-SNAPSHOT, v2.2, v2.1
?

@kaikreuzer
Copy link
Member

How about even simpler 2.1, 2.2, latest (which is imho more common on documentation than the technical word SNAPSHOT).

@bgilmer77
Copy link
Contributor

Strongly agree with LATEST. This is well aligned with the Linux world.

@ThomDietrich
Copy link
Member Author

Makes total sense to me, I'm on it.

@ThomDietrich
Copy link
Member Author

One thing I'd rather not change now (takes more time then you might think) but would be something to remember for next time. You seem to agree on the proposal by Kai, my current solution consists of "latest version, v2.2, v2.1" - If we want to get rid of the "v/version" that would be fine with me.

@bgilmer77
Copy link
Contributor

Fixing this next time is just fine with me - I do not see that this is superurgent.

@ThomDietrich
Copy link
Member Author

ThomDietrich commented Jan 7, 2018

It's done.

Please forgive me for not going the Pull Request path. This process involves three branches and 3000 files and is complicated enough 🙇
Please check if you can find any issues: https://docs.openhab.org/

@kaikreuzer
Copy link
Member

Nice work, many thanks! 👍

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

No branches or pull requests

3 participants