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

Updates to support writer's guide changes + placeholders nuance #35

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion styleguide/modules/ROOT/pages/ordered-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,26 @@

Use an ordered list when you have a procedure, task, or collection of items where the order matters.

Use a period (.) to render an item as an ordered list item.
For example:

****
. Go to menu:Data Tools[Search].
. Click btn:[Create Search Index].

The user would not be able to click the *Create Search Index* button if they did not go to menu:Data Tools[Search], first.

The order of the steps matters.
****

You must use an ordered list to write out the steps in a xref:writing-procedures.adoc[procedure topic].
It's okay to have a procedure that only contains 1 step.

You can also use an ordered list in a xref:writing-concepts.adoc[concept topic] if:

* The order of things in the list matters.
* You're describing a series of procedures or larger tasks a user must complete to accomplish a goal.

Use a period (`.`) to render an item as an ordered list item.
The number of periods sets the depth of the list item.

For more information about how to format an ordered list in Antora, see xref:home:contribute:basics.adoc#ordered-lists[Ordered Lists] in the Contributing to the Documentation guide.
29 changes: 26 additions & 3 deletions styleguide/modules/ROOT/pages/placeholders.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,32 @@
= Code Placeholders

When you need to add a placeholder value to a xref:examples.adoc[code example]:
The type of placeholder you add to code depends on the type of xref:examples.adoc[code example] you're including.

== curl and Shell Placeholders
Copy link

@lamagnifica lamagnifica May 10, 2024

Choose a reason for hiding this comment

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

cURL
(throughout)

Choose a reason for hiding this comment

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

I was surprised to find out recently that they've renamed cURL to curl.
Had to change it in a few places in the docs.


When you need to add a placeholder value to a curl or other shell code example:

* Write the placeholder name in capital letters.
* Use a `$` before the placeholder name.
* Use underscores to separate words.
* Use underscores (`_`) to separate words.

For example, `$DATABASE_NAME`.

== REST API Path Attribute Placeholders

When you need to add a placeholder value to a path attribute for a REST API example:

* Write the placeholder name in capital letters.
* Surround the placeholder name in curly braces (`{}`).
* If necessary, use underscores (`_`) to separate words.

For example, `{PORT}`.

== Other Placeholders

Choose a reason for hiding this comment

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

Is it worth emphasizing that this is the default formatting for placeholders?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know about "default" - I think I'd rather just leave it as "other" - since we want the other two options to be used where appropriate, first.


If your code format does not support a value using curly braces (`{}`) or a `$` prefix, then you must:

Choose a reason for hiding this comment

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

...for example, a value in a JSON document,...


* Write the placeholder name in capital letters.
* Surround the placeholder name in angled brackets (`<>`).

For example, `$DATABASE_NAME`.
For example, `<YOUR_ATTRIBUTE>`.
18 changes: 15 additions & 3 deletions styleguide/modules/ROOT/pages/unordered-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,24 @@
Use an unordered or bulleted list when you have a collection of three or more things and the order of the items does not matter.
These items could be nouns, phrases, or topics.

For example:

****
* This is a list item
** This is a sub-item
****

If you only have two items in your list, it's okay to just write it out in a sentence.

Use an unordered list when writing prerequisites or a See Also section in your documentation.
Use an unordered list for prerequisites and the See Also section even if it contains only a single item.
Use an unordered list when:

* Writing a prerequisites section in your documentation.
* Writing a See Also section in your documentation.
* Structuring the `nav.adoc` file in a documentation module.

NOTE: Use an unordered list for prerequisites and the See Also section even if it contains only a single item.

Use an asterix (*) to render an item as an unordered list item.
Use an asterix (`*`) to render an item as an unordered list item.

Choose a reason for hiding this comment

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

asterisk (throughout)

The number of asterixes sets the depth of the list item.

For more information about how to format an unordered list in Antora, see xref:home:contribute:basics.adoc#unordered-lists[Unordered Lists] in the Contributing to the Documentation guide.
2 changes: 1 addition & 1 deletion ui-ux/modules/ROOT/pages/good-content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ We write content that's factually correct, always.
We use the same word or words to mean the same thing.

We follow industry standards and conventions, but also our own.
(That's why we maintain a xref:styleguide:ROOT:wordlist.adoc[word list]).
(That's why we maintain a xref:styleguide:ROOT:word-list.adoc[word list]).

We adhere to our xref:voice.adoc[voice and tone standards].

Expand Down