Updates to support writer's guide changes + placeholders nuance #35
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
simon-dew
approved these changes
May 2, 2024
|
|
||
| For example, `{PORT}`. | ||
|
|
||
| == Other Placeholders |
There was a problem hiding this comment.
Is it worth emphasizing that this is the default formatting for placeholders?
There was a problem hiding this comment.
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.
ggray-cb
approved these changes
May 7, 2024
lamagnifica
reviewed
May 10, 2024
| 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 |
There was a problem hiding this comment.
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.
lamagnifica
reviewed
May 10, 2024
|
|
||
| == Other Placeholders | ||
|
|
||
| If your code format does not support a value using curly braces (`{}`) or a `$` prefix, then you must: |
There was a problem hiding this comment.
...for example, a value in a JSON document,...
lamagnifica
reviewed
May 10, 2024
|
|
||
| Use an asterix (*) to render an item as an unordered list item. | ||
| Use an asterix (`*`) to render an item as an unordered list item. |
lamagnifica
approved these changes
May 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.