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

feat: improve parameters usage description #382

Merged
merged 4 commits into from
Nov 4, 2022

Conversation

scolladon
Copy link
Owner

What does this pull request contain?


  • Added (for new features).
  • Changed (for changes in existing functionality).
  • Deprecated (for soon-to-be removed features).
  • Removed (for now removed features).
  • Fixed (for any bug fixes).
  • Security (for vulnerability fixes).

Explain your changes


Improve Admin experience by changing the name of the inputs, their descriptions and the possible value to put into

@codecov
Copy link

codecov bot commented Nov 3, 2022

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (53985ae) compared to base (6567b7a).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #382   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           30        30           
  Lines          792       792           
=========================================
  Hits           792       792           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

required: true
default: 'latest-rc'
default: 'vX.Y.Z'
Copy link
Collaborator

@mehdicherf mehdicherf Nov 3, 2022

Choose a reason for hiding this comment

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

I think I preferred the previous default values.

When I see latest-rc and latest, I assume that it's proposing to promote latest-rc to latest, making it easy for me (as an admin) to understand the meaning of those 2 parameters.

On the other hand, if I see vX.Y.Z and stable | latest | latest-rc | vA.B.C, there is no relationship between those examples that would help me understand in which direction the promotion is supposed to work.

Copy link
Owner Author

Choose a reason for hiding this comment

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

Issue here is we cannot move an alias to another alias
We need to move an alias to a version number.
This is why I changed the default values, they works as a placeholder here.
We could use a dropdown list for the second one as it cannot be a version number and it is one of those 3 (stable latest or latest-rc)

@codeclimate
Copy link

codeclimate bot commented Nov 3, 2022

Code Climate has analyzed commit 53985ae and detected 0 issues on this pull request.

View more on Code Climate.

@scolladon scolladon merged commit deeb5d1 into main Nov 4, 2022
@scolladon scolladon deleted the feat/improve-manage-version-experience branch November 4, 2022 09:29
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.

2 participants