The Wayback Machine - https://web.archive.org/web/20211031013037/https://github.com/mattermost/mattermost-server/issues/18547
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

Rename description to "run summary" #18547

Open
mattermod opened this issue Oct 5, 2021 · 1 comment
Open

Rename description to "run summary" #18547

mattermod opened this issue Oct 5, 2021 · 1 comment

Comments

@mattermod
Copy link
Contributor

@mattermod mattermod commented Oct 5, 2021

Some of our own teams incorrectly use the description template to capture a generic playbook description that never changes as opposed to summary of the specific run.

Propose we rename this field to Run summary and be more explicit in the playbook editing screen about the purpose of this box:

  • On /playbooks/runs/<playbook*run*id>/overview, change the word description to run summary, both in the title and any related text.
  • On the templates tab of /playbooks/playbooks/<playbook_id>/edit, change the title Description to Run Summary, but leave the help text unchanged.
  • In the RHS Playbooks integration for Channels, change the placeholder text Add a description... to Add a run summary...

If you're interested please comment here and come join our "Contributors" community channel on our daily build server, where you can discuss questions with community members and the Mattermost core team. For technical advice or questions related to the Playbooks product, please join our "Developers: Playbooks" community channel.

New contributors please see our Developer's Guide.

JIRA: https://mattermost.atlassian.net/browse/MM-38743

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment