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

Maintenance/docs #159

Merged
merged 2 commits into from
Dec 4, 2023
Merged

Maintenance/docs #159

merged 2 commits into from
Dec 4, 2023

Conversation

Boomatang
Copy link
Contributor

  • Update docs for better rendering of dos.kaudrant.io
  • fix broken links

Verification

  • Edited markdown pages should render correctly in
    • Github
    • Docs.kuadrant,io
  • All links should work in both locations

To help with rendering these changes on the docs site, Kuadrant/docs.kuadrant.io#41 can be used to run these changes locally

- update external links
@codecov-commenter
Copy link

codecov-commenter commented Nov 10, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d57f130) 62.85% compared to head (2b832ab) 61.63%.
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #159      +/-   ##
==========================================
- Coverage   62.85%   61.63%   -1.23%     
==========================================
  Files           1        2       +1     
  Lines         735      782      +47     
==========================================
+ Hits          462      482      +20     
- Misses        222      249      +27     
  Partials       51       51              
Flag Coverage Δ
unit 61.63% <ø> (-1.23%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

README.md Outdated
@@ -152,7 +152,7 @@ interfaces

#### OIDCServer

Configuration of the OIDC Discovery server for [Festival Wristband](https://github.com/Kuadrant/authorino/blob/main/docs/features.md#festival-wristband-tokens-responsewristband)
Configuration of the OIDC Discovery server for [Festival Wristband](https://docs.kuadrant.io/authorino/docs/features/#festival-wristband-authentication)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Configuration of the OIDC Discovery server for [Festival Wristband](https://docs.kuadrant.io/authorino/docs/features/#festival-wristband-authentication)
Configuration of the OIDC Discovery server for [Festival Wristband](https://docs.kuadrant.io/authorino/docs/features/#festival-wristband-tokens-responsesuccessheadersdynamicmetadatawristband)

@Boomatang Boomatang marked this pull request as ready for review November 20, 2023 09:29
README.md Outdated
@@ -194,7 +194,7 @@ Configuration of the metrics server.
| Field | Type | Description | Required/Default |
|-------|:-------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|
| port | Integer | Port number of the metrics server. | Default: `8080` |
| deep | Boolean | Enable/disable metrics at the level of each evaluator config (if requested in the [`AuthConfig`](https://github.com/Kuadrant/authorino/blob/main/docs/user-guides/metrics.md)) exported by the metrics server. | Default: `false` |
| deep | Boolean | Enable/disable metrics at the level of each evaluator config (if requested in the [`AuthConfig`](https://docs.kuadrant.io/authorino/docs/user-guides/observability/#metrics)) exported by the metrics server. | Default: `false` |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| deep | Boolean | Enable/disable metrics at the level of each evaluator config (if requested in the [`AuthConfig`](https://docs.kuadrant.io/authorino/docs/user-guides/observability/#metrics)) exported by the metrics server. | Default: `false` |
| deep | Boolean | Enable/disable metrics at the level of each evaluator config (if requested in the [`AuthConfig`](https://docs.kuadrant.io/authorino/docs/features/#common-feature-metrics-metrics)) exported by the metrics server. | Default: `false` |

- adjust URL ref
@Boomatang Boomatang merged commit 6f8b45c into Kuadrant:main Dec 4, 2023
8 checks passed
@Boomatang Boomatang deleted the maintenance/docs branch December 4, 2023 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants