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

[CMSP-791] WP-CLI changes did not use clear and consistent language #8818

Merged
merged 1 commit into from
Jan 10, 2024

Conversation

jms-pantheon
Copy link
Contributor

Summary

Troubleshoot WP-CLI - Changed to use clear language

Clarity and accessibility: The replacement of "What's the TL;DR?" with "Summary of changes" in the alert title improves clarity and accessibility. Avoiding internet slang and using straightforward language makes the document more accessible to screen readers and a global audience.

The removal of colloquial language like "gymnastics" is also crucial for a global audience. Technical documentation should be written in a way that is easily understandable by people from various cultural and linguistic backgrounds.

Technical terms All references now use the standard lowercase display of stdout instead of the previous mixed-case output. I have also defined the original term "standard output (stdout)" as this is a new term on the page.

Standard second person writing Pantheon's documentation should address the user as "you" and define the speaking voice, for example "At Pantheon, we do..." instead of using "I have called..."

Release:

  • When ready

Post Launch

Do not remove - To be completed by the docs team upon merge:

  • Redirect /old-path/ => /new-path/ (if applicable)
  • Include/exclude pages ^ respectively within docs search service provider (if applicable)
  • For Heroes - add a props post to the discussion board.
  • Remove from the project board

@jms-pantheon jms-pantheon requested a review from a team as a code owner January 8, 2024 17:03
Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-8818-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

Copy link
Member

@pwtyler pwtyler left a comment

Choose a reason for hiding this comment

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

Thanks for this, this document definitely started from a different headspace than "technical documentation" before we ended up here too.

@pwtyler pwtyler changed the title WP-CLI changes did not use clear and consistent language [CMSP-791] WP-CLI changes did not use clear and consistent language Jan 8, 2024
@jazzsequence jazzsequence merged commit fdd3d21 into main Jan 10, 2024
7 of 9 checks passed
@jazzsequence jazzsequence deleted the wpcli-stderr branch January 10, 2024 17:14
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