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

A collection of small documentation issues #57

Open
3 tasks
ghost opened this issue Jul 20, 2021 · 2 comments
Open
3 tasks

A collection of small documentation issues #57

ghost opened this issue Jul 20, 2021 · 2 comments

Comments

@ghost
Copy link

ghost commented Jul 20, 2021

Not sure if you want an individual issue for each of these, for the moment, I'll just make a (short) list:

  • The documentation does not indicate a document license currently. Most SUSE documentation is currently under the GFDL 1.3 but that license means you need to reproduce the entire text of the GFDL in your document. I'd suggest using a CC license, e.g. CC-BY 4.0 or similar, because CC licenses don't need to be reproduced within the document.
  • There appears to be a weird conversion issue with some smaller heads which are converted to single-step procedures: http://documentation.suse.com/keg/1/single-html/keg/#recipes-data-types (@tomschr Can you help here?)
  • optional The document still uses Title-Style Capitalization for its section titles. Within the doc team, we are now using Sentence-style capitalization (since the beginning of 2021). The idea was mostly to help new contributors with this rule. style guide
@tomschr
Copy link

tomschr commented Jul 21, 2021

There appears to be a weird conversion issue with some smaller heads which are converted to single-step procedures: http://documentation.suse.com/keg/1/single-html/keg/#recipes-data-types (@tomschr Can you help here?)

I saw that too. Probably I can help. I assume it's something wrong with the rng2docbook stylesheet. However, I don't have enough time yet to look into the details. 😢

@jgleissner
Copy link
Collaborator

Hi, sorry for leaving this for so long. I've addressed points 1 and 3 in #108. Not sure about point 2 and whether it sill applies. I also entirely forgot how to submit documentation for suse.com, so I'll need a refresher or pointer I'm afraid. @tomschr Can you help?

Also, where exactly does the "Keg 1" prefix come from in https://documentation.suse.com/sles/15-SP4/? Also not sure whether it's best located in the SLES documentation, as it's not exactly part of SLES.

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

2 participants