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

Pantheon Secrets Usage guide #9347

Open
jazzsequence opened this issue Dec 12, 2024 · 0 comments
Open

Pantheon Secrets Usage guide #9347

jazzsequence opened this issue Dec 12, 2024 · 0 comments
Assignees
Labels
Topic: CLI Terminus, Drush, WP-CLI Topic: Secrets Topic: Terminus Type: New Content Request for or PR containing new content to existing page

Comments

@jazzsequence
Copy link
Contributor

jazzsequence commented Dec 12, 2024

Priority: Medium/High

Issue Description

Our Secrets documentation lacks usage information (e.g. what are the commands I run to interact with the Secrets Manager plugin).

The Command list does not include site:secret commands (I didn't expect it to, since it's in a plugin, but importantly...)

The Terminus Plugin Directory still displays the old plugin and not the new plugin.

How will this impact users?

The Secrets documentation is lengthy and comprehensive, but without practical examples of how to interact with it, it will leave customers confused and wondering how to use it. (Experienced CLI/Terminus pros will know that they can run terminus secret and get a list of related commands and work backwards from there, but that's still not the best UX.)

Suggested Resolution

  • Add a Usage page to the Secrets guide that lists the most common commands
  • Replace the old Secrets plugin with the new on on the Plugin directory
  • (possibly) add secrets-related commands to the command list
@jazzsequence jazzsequence added Type: New Content Request for or PR containing new content to existing page Topic: Terminus Topic: Secrets Topic: CLI Terminus, Drush, WP-CLI labels Dec 12, 2024
@jazzsequence jazzsequence self-assigned this Dec 12, 2024
@jazzsequence jazzsequence changed the title Secrets Usage Pantheon Secrets Usage guide Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Topic: CLI Terminus, Drush, WP-CLI Topic: Secrets Topic: Terminus Type: New Content Request for or PR containing new content to existing page
Projects
None yet
Development

No branches or pull requests

1 participant