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

Doc updates for overlay resources #3064

Merged
merged 2 commits into from
Jun 17, 2024
Merged

Doc updates for overlay resources #3064

merged 2 commits into from
Jun 17, 2024

Conversation

EronWright
Copy link
Contributor

@EronWright EronWright commented Jun 17, 2024

Proposed changes

Some minor updates to the API docs for the overlay components:

  • link to the newer version of the respective component, since the newer versions have fixes for some of the long-standing issues with these overlays.
  • clarify the supported languages

I had considered adding a "known issues" section, e.g. to mention the dependsOn limitation, but I felt it would be overkill, and that simply linking to the newer version would suffice.

Related issues (optional)

Closes #1773
Closes #2181

Copy link

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

Copy link

codecov bot commented Jun 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.74%. Comparing base (4893b2f) to head (6615964).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3064      +/-   ##
==========================================
- Coverage   36.77%   36.74%   -0.03%     
==========================================
  Files          71       71              
  Lines        9262     9269       +7     
==========================================
  Hits         3406     3406              
- Misses       5518     5524       +6     
- Partials      338      339       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@EronWright EronWright added the impact/no-changelog-required This issue doesn't require a CHANGELOG update label Jun 17, 2024
@EronWright EronWright merged commit a8ca738 into master Jun 17, 2024
19 checks passed
@EronWright EronWright deleted the issue-2181 branch June 17, 2024 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact/no-changelog-required This issue doesn't require a CHANGELOG update
Projects
None yet
2 participants