openSUSE / suse-xsl

DocBook XSL Stylesheets for SUSE branding
Other
11 stars 10 forks source link

intra-xrefs (used especially in single-HTML) are confusing, find a better way to create references to other books #424

Closed taroth21 closed 1 year ago

taroth21 commented 3 years ago

Problem Description

See https://bugzilla.suse.com/show_bug.cgi?id=1178569#c2.

Expected Behaviour

Find a better way to solve this as this obviously confuses people.

stefanq commented 3 years ago

I'm "not authorized to access bug #1178569". WTH, what kind of privacy needs do you have with this? In the end, it's an Open Source project, right?

ghost commented 3 years ago

@stefanq The bug was reported for our commercial (but still open-source) product SLES originally. Those bugs are not public. Personally, I am annoyed as well but 1. there's a policy, 2. Bugzilla does not provide granular-enough access restrictions to open up a single component of an otherwise closed product, so we can't technically get an exception for documentation bugs.

This is the issue description though:

3.11  Upgrading a Subscription Management Tool (SMT) Server:

https://documentation.suse.com/sles/15-SP2/single-html/SLES-upgrade/#sec-update-preparation-smt-to-rmt

======
the sentence
"Please refer to Book “Repository Mirroring Tool Guide”, Chapter 2 “Migrate from SMT to RMT” in the
Repository Management Tool Guide."
can be found.
We should make this a hyper link to make it easy for customers to continue reading.

comment 1:

The link is in the source code, but it's not being resolved in the single-page version.
Thus the fall-back to the book title without link.

In the multi-page HTML version at
https://documentation.suse.com/sles/15-SP2/html/SLES-all/cha-update-preparation.html#sec-update-preparation-smt-to-rmt
the link is visible.

This is a limitation of our tool-chain.
stefanq commented 3 years ago

@sknorr Thank you Stefan! IMO the openSUSE project has a lot of legacies regarding communicating openly and unfortunately they never become aware of it. I'm with openSUSE since the 90ies, always found it to be a superior project and distribution, and I'm still waiting that they do the right steps to open up for more and easy contribution so that the project can take off. Alone the fact that for the most interesting stuff and most direct contact to developers you have to cope with their mailing lists still makes me cringe all the time. Sorry for going off topic that far.

vmoutoussamy commented 2 years ago

BTW we are now using some Public Bugzilla products for documentations issues. For instance: https://bugzilla.suse.com/buglist.cgi?list_id=13526478&product=PUBLIC%20SUSE%20Linux%20Enterprise%20Server%2015%20SP4&query_format=advanced&resolution=---&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=NORESPONSE&resolution=UPSTREAM&resolution=FEATURE&resolution=DUPLICATE&resolution=WORKSFORME&resolution=MOVED : )

tomschr commented 1 year ago

This is a current limitation of our toolchain. We are working on a solution for this in regards to SmartDocs, but for the time being this can't be solved easily.