Skip to content

Daobrien/220 document symbols#226

Merged
daobrien merged 3 commits intodevfrom
daobrien/220-document-symbols
Feb 1, 2021
Merged

Daobrien/220 document symbols#226
daobrien merged 3 commits intodevfrom
daobrien/220-document-symbols

Conversation

@daobrien
Copy link
Copy Markdown
Collaborator

@daobrien daobrien commented Feb 1, 2021

See section 3.4.1 for updates. I'm sure it could use some improvements so don't hesitate to make suggestions.

daobrien added 2 commits February 1, 2021 08:58
For some reason the original version ( ) stopped working in this,
and only this, instance.
Includes examples and also how to use inline images for icons.
@daobrien daobrien added the enhancement Will improve the guide but is not a bug or blocker. label Feb 1, 2021
@daobrien daobrien self-assigned this Feb 1, 2021
@daobrien daobrien linked an issue Feb 1, 2021 that may be closed by this pull request
en-US/Design.xml Outdated
</para>
<para>
In most cases, do not include the object type in instructions.
For example, rather than "Click the <guibutton>Save</guibutton> button," write "Click <guibutton>Save</guibutton>.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Missing "

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fixed in latest commit.

<partintro>
<para>
The Usage Dictionary provides guidelines for the correct use of common terms in Red&nbsp;Hat documentation, which terms to avoid, and the preferred spelling if variations exist.
The Usage Dictionary provides guidelines for the correct use of common terms in Red&#160;Hat documentation, which terms to avoid, and the preferred spelling if variations exist.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why replace nbsp with hex? .. isn't that more difficult to remember?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Because for some unknown reason, since F32 &nbsp; doesn't work right there. It works everywhere else, works in RHEL, haven't tested in F33. It's only this one instance so I wasn't too concerned about it.

Copy link
Copy Markdown
Collaborator

@mweetman-redhat mweetman-redhat left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Contributor

@sffrench sffrench left a comment

Choose a reason for hiding this comment

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

LGTM :)

@daobrien daobrien merged commit d7544f3 into dev Feb 1, 2021
@daobrien daobrien deleted the daobrien/220-document-symbols branch February 1, 2021 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Will improve the guide but is not a bug or blocker.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add subsection about how to click symbols, signs, and other objects

3 participants