Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ Cluster API Provider for Proxmox VE is a concrete implementation of Cluster API

## Launching a Kubernetes cluster on Proxmox VE

Check out the [quickstart guide](./docs/Usage.md#quick-start) for launching a cluster on Proxmox VE.
Check out the [quickstart guide](./docs/Usage.md#quick-start) for launching a cluster on Proxmox VE.

For a more opinionated walkthrough, have a look at the [Examples](#examples).

## Compatibility with Cluster API and Kubernetes Versions
This provider's versions are compatible with the following versions of Cluster API:
Expand Down Expand Up @@ -44,3 +46,7 @@ You can reach the maintainers of this project at:

We take security seriously.
Please read our [security policy](SECURITY.md) for information on how to report security issues.

## Examples
Copy link
Member

Choose a reason for hiding this comment

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

I'm unsure whether we place it here or in the Usage document.

Copy link
Member

Choose a reason for hiding this comment

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

@wikkyk what do you think?
Placing the examples section here or in the Usage?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I would name this section something like 'external links'. I wouldn't want to accidentally leave an impression of endorsement.

- [Proxmox-Kubernetes-Engine](https://github.com/Caprox-eu/Proxmox-Kubernetes-Engine)
- A beginner-friendly, end-to-end approach for CAPMOX, especially home-lab friendly, based on the blog post: [From Zero to Scale: Kubernetes on Proxmox (The scaling Autopilot Method)](https://dev.to/3deep5me/from-zero-to-scale-kubernetes-on-proxmox-the-scaling-autopilot-method-1l64)
Loading