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 #294

Merged
merged 5 commits into from
Nov 22, 2023
Merged

Maintenance/docs #294

merged 5 commits into from
Nov 22, 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

Copy link

codecov bot commented Nov 10, 2023

Codecov Report

Merging #294 (07ae96f) into main (a7c2c7f) will increase coverage by 0.34%.
Report is 4 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #294      +/-   ##
==========================================
+ Coverage   64.43%   64.77%   +0.34%     
==========================================
  Files          35       35              
  Lines        3787     3787              
==========================================
+ Hits         2440     2453      +13     
+ Misses       1153     1143      -10     
+ Partials      194      191       -3     
Flag Coverage Δ
integration 70.55% <ø> (+0.64%) ⬆️
unit 58.20% <ø> (ø)

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

Components Coverage Δ
api/v1beta1 (u) ∅ <ø> (∅)
pkg/common (u) 73.92% <ø> (ø)
pkg/istio (u) 30.24% <ø> (ø)
pkg/log (u) 31.81% <ø> (ø)
pkg/reconcilers (u) 33.68% <ø> (ø)
pkg/rlptools (u) 56.41% <ø> (ø)
controllers (i) 70.55% <ø> (+0.64%) ⬆️

see 6 files with indirect coverage changes

- remove TOC
- update links
- fix list render
- add markdown flag to summary blocks
- update links
- remove extra spacing
- fix list render for website
@Boomatang Boomatang marked this pull request as ready for review November 20, 2023 09:33
@Boomatang Boomatang requested a review from a team as a code owner November 20, 2023 09:33
README.md Outdated
[HTTPRoute](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRoute) object.
=======
[HTTPRoute](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io%2fv1alpha2.HTTPRoute) object.
>>>>>>> 689f000 (Update Readme)
Copy link
Contributor

Choose a reason for hiding this comment

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

👀

README.md Outdated
* Write and apply the Kuadrant's [RateLimitPolicy](doc/rate-limiting.md) and/or
[AuthPolicy](doc/auth.md) custom resources targeting the HTTPRoute resource
to have your API protected.

#### If you are a *Cluster Operator*

* (Optionally) deploy istio ingress gateway using the
<<<<<<< HEAD
Copy link
Contributor

Choose a reason for hiding this comment

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

👀

@Boomatang Boomatang self-assigned this Nov 20, 2023
@alexsnaps alexsnaps requested a review from eguzki November 22, 2023 15:36
@alexsnaps alexsnaps assigned alexsnaps and unassigned Boomatang Nov 22, 2023
@Boomatang Boomatang merged commit 846e843 into Kuadrant:main Nov 22, 2023
15 checks passed
@Boomatang Boomatang deleted the maintenance/docs branch November 22, 2023 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Status: To test
Development

Successfully merging this pull request may close these issues.

3 participants