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

Introduce docs directory #57

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Introduce docs directory #57

wants to merge 1 commit into from

Commits on Jul 21, 2024

  1. Introduce docs directory

    We want to add more workloads (stalefulset, daemonset), more storage
    (CephFS), and the new OCM discovered applications.
    
    Each variant require specific instructions or example commands so it is
    best done using one file per variant, where you can experiment with
    complete disaster recovery flow for a single variant.
    
    - Move the content we had in the main README.md to `docs/initial-setup.md`
      and `docs/ocm-rbd.md`
    - Move the content we had in `workloads/kubevirt/README.md` to
      `docs/ovm-kubevirt.md`.
    - Add `docs/create-environment.md` with short instructions how to create
      a testing environment for playing with the samples in this repo.
    - Change `README.md` to a short overview linking to all other documents.
    
    The new docs directory can be used next to create more structure
    documentation like https://docs.readthedocs.io.
    
    Signed-off-by: Nir Soffer <[email protected]>
    nirs committed Jul 21, 2024
    Configuration menu
    Copy the full SHA
    c248cd9 View commit details
    Browse the repository at this point in the history