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

Restructure documentation #48

Open
3 of 6 tasks
containerpope opened this issue Dec 19, 2019 · 1 comment
Open
3 of 6 tasks

Restructure documentation #48

containerpope opened this issue Dec 19, 2019 · 1 comment
Labels
documentation Improvements or additions to documentation M Medium issue

Comments

@containerpope
Copy link
Collaborator

containerpope commented Dec 19, 2019

To allow better user onboarding we should implement the documentation as follows:

Core Docs

  1. Introduction
    1.1 Overview
    1.2 Example
    1.2.3 Create Policies
    1.2.4 Configure Kelon
    1.2.5 Run the example
  2. Philosophy
    2.1 Why external Policy Enforcement
    2.2 What is a Policy
  3. Architecture
    3.1 Components
    3.2 Policy Translation
    3.3 Query-AST
  4. Integrating Kelon
    4.1 Services and Kelon
    4.2 Kelon and Gloo
    4.3 Kelon and Istio
  5. Extending Kelon
    5.1 Create a new datasource plugin

Operations

  1. APIs
  2. Configuration
  3. Deployment
  4. Monitoring
  5. Security

Task for restructuring

  • Apply initial structure as proposed
  • Migrate all docs from old structure into new structure
  • Update info graphics containing Query-AST
  • Adjust/Simplify example policies
  • Make version of Kelon selectable
  • Add Dividers in left navigation bar instead of nesting
@containerpope
Copy link
Collaborator Author

@dcseifert what do you think about this structure? Please add your notes into the structure so that we can boostrap this.

@dcseifert dcseifert added this to the Capability test milestone Dec 20, 2019
@dcseifert dcseifert self-assigned this Dec 20, 2019
@dcseifert dcseifert added documentation Improvements or additions to documentation M Medium issue labels Dec 20, 2019
@dcseifert dcseifert removed their assignment Jul 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation M Medium issue
Projects
None yet
Development

No branches or pull requests

2 participants