Skip to content

docs(parameters): write utility readme update main one #1280

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

Merged
merged 5 commits into from
Mar 20, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This maintenance PR introduces a new README file for the upcoming Parameters utility and updates the existing ones to link the new utility. The new README follows the same structure as the others and also includes a warning banner that informs users about the developer beta status of the utility, advising them to not use the utility in production.

How to verify this change

See rendered file in the branch.

Related issues, RFCs

Issue number: #1042

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published
  • The PR title follows the conventional commit semantics

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi self-assigned this Feb 8, 2023
@dreamorosi dreamorosi linked an issue Feb 8, 2023 that may be closed by this pull request
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Feb 8, 2023
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 8, 2023
@dreamorosi dreamorosi added do-not-merge This item should not be merged parameters This item relates to the Parameters Utility labels Feb 10, 2023
@dreamorosi dreamorosi force-pushed the 1042-docs-write-utility-readme-update-main-one branch from cd3e6d8 to a5e7e43 Compare February 15, 2023 18:49
@am29d am29d self-requested a review March 14, 2023 10:45
@dreamorosi dreamorosi assigned dreamorosi and unassigned dreamorosi Mar 14, 2023
Copy link
Contributor

@am29d am29d left a comment

Choose a reason for hiding this comment

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

besides small changes, looks good to merge

@dreamorosi dreamorosi requested a review from am29d March 17, 2023 16:27
@dreamorosi dreamorosi removed the do-not-merge This item should not be merged label Mar 17, 2023
@dreamorosi dreamorosi merged commit 720d8a3 into main Mar 20, 2023
@dreamorosi dreamorosi deleted the 1042-docs-write-utility-readme-update-main-one branch March 20, 2023 12:32
@dreamorosi
Copy link
Contributor Author

Since I addressed al the changes I am merging this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation parameters This item relates to the Parameters Utility size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: write utility readme & update main one
2 participants