DXCDT-242: Documenting connections options for all strategies via examples

[willvedd]

🔧 Changes

This PR introduces more coverage of connection options documentation. This comprehensive coverage now includes examples for all connection strategies and each example includes all configurable options. This work was done in response to reported confusion regarding connections documentation, see: #365.

Because of the way that that the documentation was generated, this was the easiest way to document and demonstrate the usage of all connection strategies. More ideal approaches were discussed but were deemed too manual and susceptible to drift. So for now, this will serve as a first pass with the possibility of more improvements over time if necessary.

📚 References

Relevant issue: #365

🔬 Testing

Manually tested by applying examples against a live tenant.

📝 Checklist

• All new/changed/fixed functionality is covered by tests (or N/A)
• I have added documentation for all new/changed functionality (or N/A)

[codecov-commenter]

Codecov Report

Base: 86.91% // Head: 86.74% // Decreases project coverage by -0.17% ⚠️

Coverage data is based on head (f79ed41) compared to base (582190b).
Patch has no changes to coverable lines.

❗ Current head f79ed41 differs from pull request most recent head afd14d0. Consider uploading reports for the commit afd14d0 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #383      +/-   ##
==========================================
- Coverage   86.91%   86.74%   -0.18%     
==========================================
  Files          40       41       +1     
  Lines        8593     8730     +137     
==========================================
+ Hits         7469     7573     +104     
- Misses        863      890      +27     
- Partials      261      267       +6     

Impacted Files	Coverage Δ
...ernal/provider/resource_auth0_connection_client.go	75.36% <0.00%> (ø)
internal/provider/provider.go	59.59% <0.00%> (+0.59%)	⬆️

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.