Skip to content

Fix style for options that are not compulsory #20616

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

Merged
merged 1 commit into from
May 15, 2020

Conversation

jboxman
Copy link
Contributor

@jboxman jboxman commented Mar 20, 2020

So IBM says:

Indicating optional and conditional steps
If a step is optional, begin the step with the word Optional. If your authoring tool provides a semantic element to generate the word Optional, use that element.

Example

  1. Optional: Click Set password. In the Password field, type a password.

Do we care about a period versus a colon for this? Do we care about optional versus optionally?

And do we want to offset this semantically, with italics or bold? (We do no, currently.)

@jboxman jboxman self-assigned this Mar 20, 2020
@jboxman jboxman added the peer-review-needed Signifies that the peer review team needs to review this PR label Mar 20, 2020
@jboxman jboxman added this to the Next Release milestone Mar 20, 2020
@openshift-docs-preview-bot

The preview will be available shortly at:

@kalexand-rh
Copy link
Contributor

So IBM says:

Indicating optional and conditional steps
If a step is optional, begin the step with the word Optional. If your authoring tool provides a semantic element to generate the word Optional, use that element.

Example

  1. Optional: Click Set password. In the Password field, type a password.

Do we care about a period versus a colon for this? Do we care about optional versus optionally?

We should be consistent where we can.

And do we want to offset this semantically, with italics or bold? (We do no, currently.)

No. That would just add more overhead.

Copy link
Contributor

@kalexand-rh kalexand-rh left a comment

Choose a reason for hiding this comment

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

LGTM

@kalexand-rh kalexand-rh added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Mar 23, 2020
@jboxman
Copy link
Contributor Author

jboxman commented Apr 9, 2020

@mburke5678 @apinnick @maximsvistunov

FYI, I replaced instances of _Optionally, _ with _Optional: _ per IBM style guide for what appear to be procedures. Let me know if that isn't correct for your modules.

Thanks!

@jboxman jboxman merged commit 45318b1 into openshift:master May 15, 2020
@jboxman
Copy link
Contributor Author

jboxman commented May 15, 2020

/cherry-pick enterprise-4.5

@jboxman
Copy link
Contributor Author

jboxman commented May 15, 2020

/cherry-pick enterprise-4.4

@openshift-cherrypick-robot

@jboxman: new pull request created: #22180

In response to this:

/cherry-pick enterprise-4.5

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot

@jboxman: new pull request created: #22181

In response to this:

/cherry-pick enterprise-4.4

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@jboxman
Copy link
Contributor Author

jboxman commented May 15, 2020

/cherry-pick enterprise-4.3

@openshift-cherrypick-robot

@jboxman: new pull request created: #22182

In response to this:

/cherry-pick enterprise-4.3

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@jboxman
Copy link
Contributor Author

jboxman commented May 15, 2020

/cherry-pick enterprise-4.2

@openshift-cherrypick-robot

@jboxman: #20616 failed to apply on top of branch "enterprise-4.2":

Using index info to reconstruct a base tree...
A	modules/cluster-logging-collector-fluentd.adoc
M	modules/migration-running-migration-plan-cam.adoc
A	modules/monitoring-enabling-monitoring-of-your-own-services.adoc
M	modules/nw-sriov-network-attachment.adoc
M	modules/odc-creating-projects-using-developer-perspective.adoc
M	modules/odc-importing-codebase-from-git-to-create-application.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/odc-importing-codebase-from-git-to-create-application.adoc
CONFLICT (content): Merge conflict in modules/odc-importing-codebase-from-git-to-create-application.adoc
Auto-merging modules/odc-creating-projects-using-developer-perspective.adoc
Auto-merging modules/nw-sriov-network-attachment.adoc
CONFLICT (content): Merge conflict in modules/nw-sriov-network-attachment.adoc
CONFLICT (modify/delete): modules/monitoring-enabling-monitoring-of-your-own-services.adoc deleted in HEAD and modified in Fix style for options that are not compulsory. Version Fix style for options that are not compulsory of modules/monitoring-enabling-monitoring-of-your-own-services.adoc left in tree.
Auto-merging modules/migration-running-migration-plan-cam.adoc
CONFLICT (modify/delete): modules/cluster-logging-collector-fluentd.adoc deleted in HEAD and modified in Fix style for options that are not compulsory. Version Fix style for options that are not compulsory of modules/cluster-logging-collector-fluentd.adoc left in tree.
error: Failed to merge in the changes.
Patch failed at 0001 Fix style for options that are not compulsory

In response to this:

/cherry-pick enterprise-4.2

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@jboxman jboxman deleted the check-optional branch May 15, 2020 16:37
@jboxman jboxman restored the check-optional branch May 15, 2020 16:38
@jboxman jboxman deleted the check-optional branch May 15, 2020 16:38
@jboxman jboxman restored the check-optional branch May 15, 2020 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
peer-review-done Signifies that the peer review team has reviewed this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants