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

docs(jmespath): add utility docs #2187

Merged
merged 5 commits into from
Mar 25, 2024
Merged

docs(jmespath): add utility docs #2187

merged 5 commits into from
Mar 25, 2024

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Mar 8, 2024

Description of your changes

This PR adds a new documentation page for the new JMESpath utility as well as code snippets to go along with it.

This page doesn't cover JMESPath foundations but focuses on how the added value of the utility. It does however link to the official JMESPath tutorial.

Note

The code referenced in these docs might have not been merged on main yet, however the PR is ready for review and can be merged independently. If you want to look at the implementation you can check the feat/jmespath branch under packages/jmespath/src.

Related issues, RFCs

Issue number: #2186

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
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • 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.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Mar 8, 2024
@dreamorosi dreamorosi requested review from a team as code owners March 8, 2024 17:10
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Mar 8, 2024
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Mar 8, 2024
@dreamorosi dreamorosi linked an issue Mar 8, 2024 that may be closed by this pull request
1 task
@pull-request-size pull-request-size bot added size/XL PRs between 500-999 LOC, often PRs that grown with feedback and removed size/L PRs between 100-499 LOC labels Mar 21, 2024
docs/utilities/jmespath.md Outdated Show resolved Hide resolved
docs/utilities/jmespath.md Outdated Show resolved Hide resolved
docs/utilities/jmespath.md Outdated Show resolved Hide resolved
docs/utilities/jmespath.md Outdated Show resolved Hide resolved
docs/utilities/jmespath.md Outdated Show resolved Hide resolved
docs/utilities/jmespath.md Outdated Show resolved Hide resolved
@dreamorosi dreamorosi requested a review from sthulb March 24, 2024 19:36
@dreamorosi
Copy link
Contributor Author

Thank you for the review @sthulb - addressed all the comments and resolved merge conflicts.

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@dreamorosi dreamorosi merged commit 54f9b17 into main Mar 25, 2024
12 checks passed
@dreamorosi dreamorosi deleted the docs/jmespath branch March 25, 2024 00:23
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 size/XL PRs between 500-999 LOC, often PRs that grown with feedback
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: add JMESPath utility documentation
2 participants