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

Links to add-on documentation in Paper UI are broken #295

Closed
MHerbst opened this issue Feb 5, 2017 · 6 comments
Closed

Links to add-on documentation in Paper UI are broken #295

MHerbst opened this issue Feb 5, 2017 · 6 comments

Comments

@MHerbst
Copy link
Contributor

MHerbst commented Feb 5, 2017

Due to a change in the documentation structure (commit 5be5bc2 @kaikreuzer ) it seems that all links to add-on docs are broken. The add-ons are using URLs like this:

http://docs.openhab.org/addons/bindings/allplay/readme.html

But the URLs have changed to:

http://docs.openhab.org/addons/bindings/oh2/allplay/readme.html

... and there seem to be no redirects.

BTW: The links in the search results are currently also wrong until Google has reindexed everything :-(.

@MHerbst MHerbst changed the title Links to add-on documentation are broken Links to add-on documentation in Paper UI are broken Feb 5, 2017
@watou
Copy link
Contributor

watou commented Feb 5, 2017

This could be addressed by using this Jekyll plugin and a small change to the build process.

watou added a commit to watou/openhab-docs that referenced this issue Feb 6, 2017
Requires installation of [jekyll-redirect-from](https://github.com/jekyll/jekyll-redirect-from) plugin.

Fixes openhab#295

Signed-off-by: John Cocula <john@cocula.com>
@ThomDietrich
Copy link
Member

I'm not sure if we really need to address that. I've added redirects in the past but for the main articles. Do we need every bindings old URL? Google will update quickly and links posted in the forum or somewhere else will loose their importance quickly. The user will see our 404 page and can go from there.

@kaikreuzer
Copy link
Member

@watou & @ThomDietrich I think you are missing the severity of this issue:

The links mentioned by @MHerbst are used in the openHAB Distro (Paper UI -> Addons) to link to the documentation of the according add-ons.
ALL OF THOSE LINKS ARE NOW BROKEN FOR ALL USERS. As openHAB 2.0.0 is out there, we cannot change these links.
I wasn't aware that @watou's refactoring changed these links, this should not have happened.

@watou
Copy link
Contributor

watou commented Feb 6, 2017

I think you are missing the severity of this issue:

No I am not; I've submitted now two PRs to address it. As I was not aware that PaperUI had a documentation link for 2.x bindings.

Will #297 allow users to access OH1 binding docs?

@kaikreuzer
Copy link
Member

No I am not;

Right, this comment was rather meant for @ThomDietrich as he suggested not to fix it :-)

Will #297 allow users to access OH1 binding docs?

Once merged, I can do the necessary adaptions in the distro. Currently, there simply is no link to docs in the PaperUI for 1.x add-ons.

@ThomDietrich
Copy link
Member

I was in fact not aware of that. Great you found a solution!

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