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

Introduce &productnameshort; entity #279

Merged
merged 1 commit into from
Nov 30, 2022
Merged

Conversation

tomschr
Copy link
Contributor

@tomschr tomschr commented Nov 29, 2022

PR creator: Description

Introduce &productnameshort; entity as discussed in SLE Writers Call on 2022-11-21.

Tahlia, if you are okay with the change, I will take care of cherry-picking it into the different branches.

PR creator: Are there any relevant issues/feature requests?

  • DOCTEAM-828

PR creator: Which product versions do the changes apply to?

PR reviewer only: Have all backports been applied?

The doc team member merging your PR will take care of backporting to older documents.
When opening a PR, do not set the following check box.

  • all necessary backports are done

Fixes DOCTEAM-828 which was discussed in SLE Writers Call
on 2022-11-21
@tomschr tomschr requested a review from tahliar November 29, 2022 10:04
@tomschr tomschr self-assigned this Nov 29, 2022
Copy link
Collaborator

@tahliar tahliar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it also need to go in the article_*.xml files, or is it not needed there because of book_quickstarts.xml?

@tomschr
Copy link
Contributor Author

tomschr commented Nov 30, 2022

Does it also need to go in the article_*.xml files, or is it not needed there because of book_quickstarts.xml?

If every article is incorporated through the set, it is enough to have it inside the MAIN file. The stylesheets climb up the ancestor nodes up to <set> and extract the information from the set/info element.

If I recall correctly, in former SPs, some articles were independent from MAIN (not included). In such a case, the information needs to go into the respective article of course.

@tomschr
Copy link
Contributor Author

tomschr commented Nov 30, 2022

I looked in the different maintenance branches with the command grep MAIN DC-* | cut -d '=' -f2 | sort | uniq:

  • 15 SP4: only MAIN.SLEHA.xml
  • 15 SP3: only MAIN.SLEHA.xml
  • 15 SP2: only MAIN.SLEHA.xml
  • 15 SP1: only MAIN.SLEHA.xml
  • 15 GA: only MAIN.SLEHA.xml
  • 12 SP5: only MAIN.SLEHA.xml
  • 12 SP4: art_sle_ha_geo_quick.xml, art_sle_ha_install_quick.xml, book_sle_ha_geo.xml, MAIN.SLEHA.xml

I wasn't that wrong. 😉 Only for 12 SP4 we need to take care to insert the <productname role="abbrev"> element in the respective MAIN file.

@tomschr tomschr marked this pull request as ready for review November 30, 2022 07:17
@tomschr tomschr merged commit 631e59b into main Nov 30, 2022
@tomschr tomschr deleted the feature/toms-productnameshort branch November 30, 2022 07:30
@tomschr
Copy link
Contributor Author

tomschr commented Nov 30, 2022

@tahliar All cherry-picking are done, the respective commits are added in the original description.
As mentioned in my last comment, for 12 SP4 I've inserted the additional <productname role="abbrev"> for every article. We should be on the safe side now.

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

Successfully merging this pull request may close these issues.

2 participants