Git Product home page Git Product logo

docs.kuadrant.io's Introduction

kuadrant

docs.kuadrant.io's People

Contributors

alexsnaps avatar boomatang avatar guicassolato avatar jasonmadigan avatar laurafitzgerald avatar maleck13 avatar mikenairn avatar openshift-ci[bot] avatar openshift-merge-bot[bot] avatar openshift-merge-robot avatar pehala avatar pmccarthy avatar r-lawton avatar sergioifg94 avatar ygnas avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

docs.kuadrant.io's Issues

Define how to "freeze" a Kuadrant release

We need to define how we'd freeze the docs on some release of Kuadrant (and its sub-components).
Should the website support versioned docs? Only for Kuadrant? For every components? Only support latest, but of the "right" components?

Change navigation

Based on conversation here, update docs navigation

Overview (what is currently shown in Getting Started link)
Getting Started
  - Quick Start
  - Install
Concepts and APIs
   - Gateways
   - DNSPolicy
   - TLSPolicy
   - RateLimitPolicy
   - AuthPolicy
Experimental
    - E/W stuff
Components
   - MCG
   - Authorino 
    ...

Confusing component naming

In Overview (https://docs.kuadrant.io/) we describe the individual components, yet in Installation (https://docs.kuadrant.io/multicluster-gateway-controller/docs/installation/control-plane-installation/ and https://docs.kuadrant.io/multicluster-gateway-controller/docs/installation/service-protection-installation/) we use new terms of Control Plane and Service Protection, which are only used in those guides. The rest of the guides use again individual component names, like Authorino, or MGC.

I would add an explanation to the Overview that explain both Control Plane and Service Protection, instead of describing individual components

New RateLimitPolicy guide to follow after gateway walkthrough

What

Prior to a recent docs re-org, we used to have a simple guide to setting up an RLPv1 policy for basic rate limiting for a Gateway. The previous guide covered both the installation of Limitador, as well as a guide to setting up a simple RLP.

With our new guides on how to set up the data plane, and with our new quickstarts, we should now be able to create a simple guide to setting up a basic RateLimitPolicy, in a multi-cluster Gateway scenario. The actual docs might live in the Kuadrant operator, or somewhere else more appropriate.

Let's create a new guide to follow up after our Gateway walkthrough, to look at both simple RLP and AuthPolicy.

We have lots of content that should cover this already, e.g. https://docs.kuadrant.io/kuadrant-operator/doc/user-guides/simple-rl-for-app-developers/. We could also consider altering that guides setup steps for two routes (one via quickstart, one standalone).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.