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

Add user visible description field to recipe revisions #1199

Open
mythmon opened this issue Feb 28, 2018 · 4 comments
Open

Add user visible description field to recipe revisions #1199

mythmon opened this issue Feb 28, 2018 · 4 comments
Labels

Comments

@mythmon
Copy link
Contributor

mythmon commented Feb 28, 2018

Recipe revisions should include a description field. This should be an optional field, and won't be included in the minimal recipe serializer used in /api/v1/recipe/signed/.

This is different from #1082 (a general notes field) in that it is outward facing. It should be suitable to be seen in Firefox and as a description on dashboard for a recipe. The notes field would be for users of the Normandy admin itself, and although not private, its audience is users of the Normandy system itself.

@mythmon mythmon added Enhancement P3 We'll work on this in the future labels Feb 28, 2018
@anubhavsinha98
Copy link

Hey can I work on this issue?

@mythmon
Copy link
Contributor Author

mythmon commented Aug 24, 2018

Hi @anubhavsinha98. Thanks for the interest. Feel free to work on this issue. However, Normandy is a sort of challenging project for external contributors. It might be worth joining us in #normandy on irc.mozilla.org before you get started.

@anubhavsinha98
Copy link

Thanks @mythmon for mentioning ! Well I am a very much new to open source and just started contributing so can you just help me out in clearing this issue !

@shell1 shell1 added P5 - Low Priority Patches welcome and removed P3 We'll work on this in the future good-first-bug labels Jul 12, 2019
@shell1
Copy link
Collaborator

shell1 commented Jul 12, 2019

since this was filed - we have built this in a different way. modern preference and add-on studies have this idea included. will grow out old type of experiments. will need to add to any new type of content and current solution not backwards compatible (older clients).

we could build it more ideal, generic way (so left as P5) - but today it is a property of specific actions to have user facing description. not all actions have this. it's an action argument instead of property of recipe revision.

Slug is likely the bigger impact. slug in API, exposed in name in delivery console, distinct from other name...

@jaredlockhart jaredlockhart added this to the Backlog milestone Jul 12, 2019
@jaredlockhart jaredlockhart removed this from the Backlog milestone Apr 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants