Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: rich parameters #6074

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.

Sign up for GitHub

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

Jump to bottom
Closed
Tracked by #6075
mtojek opened this issue Feb 7, 2023 · 5 comments · Fixed by #6556
Closed
Tracked by #6075

docs: rich parameters #6074

mtojek opened this issue Feb 7, 2023 · 5 comments · Fixed by #6556
Assignees
@mtojek @bpmct
Labels
parameters Area: parameters
Milestone
Rich Parameters GA

Comments

@mtojek
Copy link
Member

mtojek commented Feb 7, 2023 •
edited
Loading

Extracted from: #5574

The goal of this issue is to describe rich parameters and document all related properties, types, validation, etc. The documentation should also contain guidelines on how to migrate from old parameters to new ones.
This was referenced Feb 7, 2023
Closed
Closed
@mtojek mtojek self-assigned this Feb 12, 2023
@mtojek
Copy link
Member Author

mtojek commented Feb 12, 2023 •
edited
Loading

Items to cover with docs:

  • What features do rich parameters introduce?
  • Describe validation modes
  • Describe how mutable parameters work
  • Describe how required parameters work
  • How users can migrate old parameters to rich ones?
  • Conflict between old parameters and rich parameters (can't use together)

@mtojek mtojek mentioned this issue Feb 23, 2023
Closed
@bpmct bpmct mentioned this issue Feb 23, 2023
Merged
@bpmct bpmct assigned bpmct and unassigned mtojek Feb 24, 2023
@ammario ammario changed the title Rich parameters: write documentation docs: rich parameters Feb 24, 2023
@matifali
Copy link
Member

matifali commented Feb 27, 2023 •
edited
Loading

Items to cover with docs:

  • What features do rich parameters introduce?
  • Describe validation modes
  • Describe how mutable parameters work
  • Describe how required parameters work
  • How users can migrate old parameters to rich ones?
  • Conflict between old parameters and rich parameters (can't use together)

I am writing a blog post that uses examples to address many of these questions. You are welcome to give your feedback. coder/blogs#1
cc: @mtojek

@mtojek mtojek added the parameters Area: parameters label Feb 28, 2023
@bpmct bpmct added this to the Rich Parameters GA milestone Feb 28, 2023
@mtojek mtojek self-assigned this Mar 8, 2023
@mtojek
Copy link
Member Author

mtojek commented Mar 8, 2023

I'm going with the missing doc sections

@mtojek mtojek mentioned this issue Mar 9, 2023
Merged
@mtojek
Copy link
Member Author

mtojek commented Mar 9, 2023

How users can migrate old parameters to rich ones?

This is the last item missing, but it's partially blocked by: #6368

@matifali
Copy link
Member

matifali commented Mar 9, 2023

The docs look great.

@mtojek mtojek mentioned this issue Mar 13, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mtojek mtojek

@bpmct bpmct

Labels
parameters Area: parameters
Projects
None yet
Milestone
Rich Parameters GA
Development

Successfully merging a pull request may close this issue.

feat: import value from legacy variable to build parameter mtojek/coder
3 participants
@matifali @mtojek @bpmct