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

Per-route options via CF cli #543

Merged
merged 24 commits into from
Feb 6, 2025
Merged

Conversation

Dariquest
Copy link
Contributor

@Dariquest Dariquest commented Jan 31, 2025

Documentation adjustments for
cloudfoundry/cli#3372
cloudfoundry/cli#3366

Copy link
Contributor

@hoffmaen hoffmaen left a comment

Choose a reason for hiding this comment

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

Please rename all occurences of least-connections to least-connection.

@Dariquest
Copy link
Contributor Author

Please rename all occurences of least-connections to least-connection.

Thanks, done!

changed "one can" to "you can"
added colons to procedure steps
changed "execute" to "run"
removed "via" (Latinisms are not used in CF doc set)
@anita-flegg
Copy link
Contributor

I made formatting and wording edits.
Remember that every line between numbered steps must be indented. Without this, the list restarts at 1 after every non-indented line.

@Dariquest
Copy link
Contributor Author

I made formatting and wording edits. Remember that every line between numbered steps must be indented. Without this, the list restarts at 1 after every non-indented line.

Thanks, Anita @anita-flegg. Is using "you can" instead of "one can" less formal?

@anita-flegg
Copy link
Contributor

@Dariquest , "you can" might be considered less formal, but it's really a style choice. And once a style choice has been made, it's important to maintain internal consistency across the doc set. The whole doc set uses "you" to speak directly to the reader.
The older usage "one can," etc. is not wrong, but it is no longer used in any tech writing group in any company I know of.

So the bottom line is that the change to "you can" in this case is to maintain consistency within the CF doc set.

@Dariquest
Copy link
Contributor Author

@Dariquest , "you can" might be considered less formal, but it's really a style choice. And once a style choice has been made, it's important to maintain internal consistency across the doc set. The whole doc set uses "you" to speak directly to the reader. The older usage "one can," etc. is not wrong, but it is no longer used in any tech writing group in any company I know of.

So the bottom line is that the change to "you can" in this case is to maintain consistency within the CF doc set.

I am for consistency either, thanks a lot!

Copy link
Contributor

@hoffmaen hoffmaen left a comment

Choose a reason for hiding this comment

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

One more remark: To not get confused with the map-route command, having MY-APP for both the app name and route: Maybe use MY-HOST throughout the whole site for the route name.

custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
Copy link
Contributor

@hoffmaen hoffmaen left a comment

Choose a reason for hiding this comment

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

Last round :)

custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Show resolved Hide resolved
custom-per-route-options.html.md.erb Outdated Show resolved Hide resolved
custom-per-route-options.html.md.erb Show resolved Hide resolved
@anita-flegg anita-flegg merged commit 431ce3b into cloudfoundry:master Feb 6, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants