openSUSE / doc-ci

Continuous integration for SUSE documentation
4 stars 6 forks source link

Make susedoc.github.io paths more similar to doc.suse.com paths #23

Closed ghost closed 4 years ago

ghost commented 4 years ago

We have different path styles on susedoc.github.io and on doc.suse.com:

doc.s.c:  domain / [lang /] product / version / format   / document
sd.gh.io: domain /          product / branch  / document / format 

@mnapp remarks that it would be great if we could switch susedoc.github.io to the format/document style, to make it possible to reuse/redefine URL definitions from the beta page for production.

ghost commented 4 years ago

@fsundermeyer / @taroth / @r0ckarong / @tbazant / @tomschr

I made a quick/dirty fix for this. The fix involves breaking any deeplinks we have to the susedoc.github.io page. However, it will still provide a redirecting index.html file to the books/articles main pages. Is this an acceptable compromise or do you see this becoming an issue?

i.e.

(new addresses would be: https://susedoc.github.io/doc-sle/master/html/SLES-admin/cha-grub2.html, https://susedoc.github.io/doc-sle/master/html/SLES-admin/index.html)

r0ckarong commented 4 years ago

The justification behind this is that we need to sometimes use URLs that do not exist yet in the final location (most often for release notes or beta). The release notes get packaged before we ship the documentation so I can not verify beforehand that the URLs are actually correct. If they DO exist on susedoc.github.io I can be pretty sure that the ID points to an existing anchor.

Then I just update the attribute in our attributes.adoc file that defines the URL "prefix" and the final docs will point to existing stuff on suse.com.

ghost commented 4 years ago

Had no negative feedback.->Pushed.