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

[docker.md] This page is a bit out of date #1953

Open
rkoshak opened this issue Dec 11, 2022 · 9 comments
Open

[docker.md] This page is a bit out of date #1953

rkoshak opened this issue Dec 11, 2022 · 9 comments

Comments

@rkoshak
Copy link
Contributor

rkoshak commented Dec 11, 2022

The docker.md page is really out of date and missing a whole lot of stuff. So we either need to revamp this page, or even better, pull this page from the README.md file of the openhab-docker repo which has way more details and information.

@wborn
Copy link
Member

wborn commented Dec 12, 2022

Can you transfer this issue to the openhab-docs repo @kaikreuzer?

@rkoshak
Copy link
Contributor Author

rkoshak commented Dec 12, 2022

I wasn't sure where to best put it. I know that @Confectrician has to do some magic on the openhab-docs end to pull the README similar to how add-ons are pulled.

@wborn
Copy link
Member

wborn commented Dec 12, 2022

Maybe it is also possible to process the README so it does not show certain content like the badges, openHAB logo and container build instructions?

@rkoshak
Copy link
Contributor Author

rkoshak commented Dec 12, 2022

That's going to be a question for @Confectrician. I've just run into too many people who don't click through, even though we tell them to, to get to all the great stuff in the README. And it occurs to me that it's wasteful to maintain two sets of docs when the README has basically everything.

Almost totally unrelated, but the table of contents and links to the section headings doesn't work in Dockerhub. It's kind of a pain because we can't link straight to the relevant sections of the docs. I'm not sure if that will pop up here too or not, since I can't tell why it does't work.

@Confectrician
Copy link
Contributor

If there is a docker.md in this repo you may point me to it's location.

If you are talking about some file in another repo (Probably https://github.com/openhab/openhab-docker could be suitable) it would be nice if you clarify source and target for me, before i start guessing (an dprobably do wrong guesses).

Thanks in advance.

@rkoshak
Copy link
Contributor Author

rkoshak commented Dec 13, 2022

I was thinking of https://github.com/openhab/openhab-docker but I'm just now noticing this got moved to the addons repo. So now I'm confused, are there three versions of the docs, on in openhab-docs, one in openhab-docker, and one here?

@Confectrician
Copy link
Contributor

Not to my knowledge, but i am asking too, because this issue is currently in openhab-addons.

@Confectrician Confectrician transferred this issue from openhab/openhab-addons Dec 13, 2022
@Confectrician
Copy link
Contributor

So, clean start in the docs repo now.

If i am right the docker repo can tehoretically be independent from the openhab release.
Mostly this won't make sense, but theoretically it is possible.
So we could simply handle it's Readme.md like any other external tool like google assistant, openhabian or alexa.

We have to adapt the script a bit for this repo probably, but it should be possible.
We can also create a ruby script or function to strip of the contents that are special for dockerhub, but are not needed on the docs website.

@rkoshak
Copy link
Contributor Author

rkoshak commented Dec 13, 2022

If i am right the docker repo can tehoretically be independent from the openhab release.

Yes, that's true. We keep running into that more and more, don't we.

In truth, the logo and stuff at the top for Dockerhub doesn't bother me much. Definitely not as much as making sure we have stuff in the main docs like the docker-compose example, how to pass through a device, and stuff like that. So if it makes sense to pull it in as in and leave for a little later stripping off the top stuff I for one would think that's just fine.

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

4 participants