Fix example of an abstract in the book outline

Question

Fix example of an abstract in the book outline

janajaeger opened this issue 3 years ago · 5 comments

We have updated the character limits for the abstract, but the example listed right below does not adhere to that and has still over 300 characters.

Answer 1 · 2022-03-23T11:34:00.000Z

We can borrow the example from here:
https://documentation.suse.com/kiwi/9/html/kiwi/contributing.html
The first one will do.

Answer 2 · 2022-03-23T12:58:29.000Z

I would disagree. The "In this chaper, you learn to ..." or "This document describes" is pretty unnecessary IMHO and wastes precious characters. I think Christoph accepted the challenge to write short and snappy abstracts a while ago. Maybe check with him.

Answer 3 · 2022-04-05T10:58:54.000Z

Suggestion (from Brandon's message on SEO):

Perform an upgrade of a SUSE Linux Enterprise system to a new major version in environments which do not allow for standard booting of the installation.

Answer 4 · 2022-04-05T11:35:14.000Z

The paragraph about the Abstract is featured twice in the style guide.

Suggestion: Remove the second instance from the section "Chapters".

Answer 5 · 2022-04-13T11:09:27.000Z

I would like to disagree again. The first instance covers things on the book level and the second on the chapter level. I'd not use the example with the second instance, but otherwise keep it around.