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.

Sign up for GitHub

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

Jump to bottom

Define para as the first element of every step #84

Closed
tomschr opened this issue Sep 26, 2018 · 1 comment
Closed

Define para as the first element of every step #84

tomschr opened this issue Sep 26, 2018 · 1 comment
Labels
fixed section-structure an issue in the "Structure" section type-enhancement an enhancement

Comments

@tomschr
Copy link
Contributor

tomschr commented Sep 26, 2018

In openSUSE/daps#478, Markus Napp discovered a use case which we do not want to support: having an image as a first child inside a step.

Probably it needs only one sentence in our styleguide to clarify it.
@tomschr tomschr added the type-enhancement an enhancement label Sep 26, 2018
@tomschr tomschr assigned ghost Sep 26, 2018
@ghost ghost removed their assignment Oct 22, 2018
tomschr added a commit to openSUSE/geekodoc that referenced this issue Mar 7, 2019
@tomschr
Fix #59: Enforce para as first child in step
97cfc80 
This fix is needed to avoid non-para elements as a first child
in step like images, lists, etc.
In other words, step allows para, formalpara, or remark as first
child only. Of course, after a para, formalpara, or remark, any
other element as before can be used.

Related issue for the styleguide: SUSE/doc-styleguide#84
tomschr added a commit to openSUSE/geekodoc that referenced this issue Mar 7, 2019
@tomschr
Fix #59: Enforce para as first child in step
ae0ba59 
This fix is needed to avoid non-para elements as a first child
in step.

Related issue for the styleguide: SUSE/doc-styleguide#84
tomschr added a commit to openSUSE/geekodoc that referenced this issue Mar 7, 2019
@tomschr
Fix #58: Enforce para as first child in step
7efbabc 
This fix is needed to avoid non-para elements as a first child
in step.

Related issue for the styleguide: SUSE/doc-styleguide#84
@ghost ghost added the section-structure an issue in the "Structure" section label Sep 23, 2020
@ghost ghost changed the title Clarify use of steps and para in styleguide Define para as the first element of every step Sep 23, 2020
@dariavladykina
Copy link
Contributor

This is mentioned in the 'Procedures' subsection, so closing as fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
fixed section-structure an issue in the "Structure" section type-enhancement an enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tomschr @dariavladykina