Skip to content

Commit

Permalink
Merge pull request #59 from macolso/readme-update
Browse files Browse the repository at this point in the history
Update README.md to reflect latest doc changes
  • Loading branch information
macolso authored Feb 15, 2024
2 parents 0bfddea + 28ce87e commit a04d126
Showing 1 changed file with 26 additions and 6 deletions.
32 changes: 26 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,38 @@
- [Spin Operator](#spin-operator)
- [Getting Started](#getting-started)
- [Deploying Spin Operator On Your Cluster](#deploying-spin-operator-on-your-cluster)
- [Scaling SpinApps](#scaling-spinapps)
- [Feedback](#feedback)
- [Contributing](#contributing)
- [Official Documentation](#official-documentation)

# Spin Operator

The spin operator enables deploying Spin applications to Kubernetes. It watches [SpinApp Custom Resources](./documentation/content/custom-resource-definition-reference.md) and realizes desired state in the Kubernetes cluster. This project was built using the Kubebuilder framework and contains a Spin App CRD and controller.
The Spin Operator enables deploying Spin applications to Kubernetes. It watches [SpinApp Custom Resources](./documentation/content/custom-resource-definition-reference.md) and realizes desired state in the Kubernetes cluster. This project was built using the Kubebuilder framework and contains a Spin App CRD and controller. To learn more about the SpinKube organization, visit our [project overivew documentation](./documentation/content/project-overview.md)

## Getting Started
At this point in the priview, we recommend testing Spin Operator on a local k3d cluster via `make install`. The [quickstart guide]((./documentation/content/quickstart.md) ) will walk you through prequisites and the installation workflow.

See [Quickstart](./documentation/content/quickstart.md).
>> Spin Operator installation via Helm chart for remote clusters while in private preview is WIP and can tracked [here](https://github.com/spinkube/spin-operator/issues/54). In the meantime, please use the guidance from our quickstart guide.
## Official Documentation

Our content is under developement as markdown source files located at the [documentation](./documentation/) section. The following articles are ready for review

**Tutorials**
* [Quickstart](./documentation/content/quickstart.md)
* [Scale Spin Apps with Horizontal Pod Autoscaler](./documentation/content/scaling-spinapp-on-k8s-with-hpa.md)
* [Scale Spin Apps with Kubernetes Event Driver Autoscaler](./documentation/content/scaling-spinapp-on-k8s-with-keda.md)

**Glossary, Reference, & Misc.**
* [Glossary](./documentation/content/glossary-of-terms.md)
* [Spin App Custom Resource Definition](./documentation/content/custom-resource-definition-reference.md)
* [Troubleshooting](./documentation/content/troubleshooting.md)

Remaining articles are under construction. You're welcome to view and [open issues](https://github.com/spinkube/spin-operator/issues/new), but please proceed with caution as they are subject to change.

## Feedback

For questions or support, please visit our [Discord channel](https://discord.com/channels/926888690310053918/1200012610196738208). If you would like to file a feature, bug report, or documentation request, please [open a new issue](https://github.com/spinkube/spin-operator/issues/new).

## Contributing

Expand All @@ -19,8 +42,5 @@ Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for a guide on how to contribute

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)

## Official Documentation

The documentation is published at [https://TODO-use-hugo-and-github-pages](https://TODO-use-hugo-and-github-pages)

Documentation source files are located in the [documentation](./documentation/) section.

0 comments on commit a04d126

Please sign in to comment.