Skip to content

Restructure the README file to allow separate instructions for creating clusters and installing driver #94

@mortent

Description

@mortent

Currently the README file goes through a single long section that includes building the image, creating a kind cluster, and instructions for running and validating the examples. If we want to add instructions for running the example driver on other Kubernetes distributions, we should restructure it so that we can have separate sections for what differs, but keep a single section for running and validating the examples.

I propose a structure like this:

- Intro
- Demo
  - High-level description of the demo
    - Prerequisites shared by all ways of running the demo (i.e. Helm and kubectl)
  - Creating a cluster and building/installing the example driver
    - Kind
    - GKE
    - Others...
  - Run through the examples with validation
  - Cleanup
    - Kind
    - GKE
    - Others...
- Anatomy of a DRA resource driver
- Code organization
- Best practices

An alternative would be to split this out into multiple files, but I think we can do that later if we find that the size of the README file becomes unwieldy.

Metadata

Metadata

Assignees

No one assigned

    Labels

    lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.

    Type

    No type

    Projects

    Status

    🔖 Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions