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

Improve the way beta builds are marked #275

Open
ghost opened this issue Oct 25, 2021 · 2 comments
Open

Improve the way beta builds are marked #275

ghost opened this issue Oct 25, 2021 · 2 comments
Labels
enhancement New feature or request P3: hmmm Kinda important

Comments

@ghost
Copy link

ghost commented Oct 25, 2021

@taroth21 / @fsundermeyer / @tomschr -- I'd be happy about some feedback on this, because I am not sure in what way this issue should best be attacked.

  • Previous solution: just run DAPS with --draft
    • Looks a bit unprofessional, because --draft also turns on file metadata blocks and remarks
  • Current solution: run DAPS normally (Adding DRAFT status to DC files SUSE/doc-modular#37)
    • No difference to final version.
  • Solution for susedoc.github.io:
    • Run DAPS normally but hack a clickable banner into each document
    • The idea is not so bad (I think) but the implementation is extremely ugly, let's not do it like that for the proper site.

Things I can imagine:

  1. --beta parameter in DAPS or just a regular XSLT parameter like $beta-content=1

    • Could trigger adding the aforementioned banners via the stylesheets
    • Not sure where to source content for the banners from -- ideally, the content should be translatable and also depend on the product.
  2. Profile for PROFCOND=beta in DC files

    • Would trigger whatever is defined in the XML sources. (For example, a different &productnumber;, e.g. 1.0 beta instead of 1.0)
    • This approach is already used for the release notes, where it triggers display of an additional paragraph in the abstract (not super-effective, no).
  3. Some kind of special markup like <dm:betatext>This is beta software. It gives you special powers.</dm:betatext>

    • This could be combined with the triggers from (1)
    • Would be displayed at the top of each page or as a banner or something.

What do you say?

@ghost ghost added enhancement New feature or request P3: hmmm Kinda important labels Oct 25, 2021
@fsundermeyer
Copy link
Member

fsundermeyer commented Oct 26, 2021

Regarding the current draft output:
The output of the metadata block is caused by the stylesheets. It should be removed from the stylesheets as a default output for the draft status and only be activated with a second parameter (we could use the existing "meta" parameter).

Generally I suggest to go for option 1, this would also be in line with openSUSE/daps#638

@ghost
Copy link
Author

ghost commented Nov 2, 2021

@fsundermeyer By "go for option 1", do you mean that you'd implement a --beta switch in DAPS or that we should just add a $beta-content parameter in XSLT?

And oof, you're right, this is triggered by the stylesheets for some reason, not by DAPS,
https://github.com/openSUSE/suse-xsl/blob/53b25c437f77c576a6986764844d2599d882a8c4/suse2021-ns/xhtml/sections.xsl#L282-L287

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request P3: hmmm Kinda important
Projects
None yet
Development

No branches or pull requests

1 participant