Skip to content

📖 Move all docs to the book #1316

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.

Sign up for GitHub

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

Merged
k8s-ci-robot merged 2 commits into from
Apr 15, 2021
Merged

📖 Move all docs to the book #1316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9088140
:book: Move all docs to the book
Apr 15, 2021
0eecfea
Improve external provider config doc wording
Apr 15, 2021
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ If you're new to the project and want to help, but don't know where to start, we

1. If you haven't already done so, sign a Contributor License Agreement (see details above).
2. Fork the desired repo, develop and test your code changes.
1. See the [Development Guide](docs/development.md) for more instructions on setting up your environment and testing changes locally.
1. See the [Development Guide](https://capz.sigs.k8s.io/developers/development.html) for more instructions on setting up your environment and testing changes locally.
3. Submit a pull request.
1. All PRs should be labeled with one of the following kinds
- `/kind feature` for PRs releated to adding new features/tests
Expand Down
11 changes: 5 additions & 6 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Quick start

- [Getting started](getting-started.md)
- [Getting started](https://capz.sigs.k8s.io/topics/getting-started.html)
- [Cluster API quick start](https://cluster-api.sigs.k8s.io/user/quick-start.html)

## Features
Expand All @@ -15,12 +15,11 @@

## Development

- [Development guide](development.md)
- [Kubernetes developers](topics/kubernetes-developers.md)
- [Development guide](https://capz.sigs.k8s.io/developers/development.html)
- [Kubernetes developers](https://capz.sigs.k8s.io/developers/kubernetes-developers.html)
- [Proposals](proposals)
- [Releasing](releasing.md)
- [Releasing](https://capz.sigs.k8s.io/developers/releasing.html)

## Troubleshooting

- [Troubleshooting guide](troubleshooting.md)

- [Troubleshooting guide](https://capz.sigs.k8s.io/topics/troubleshooting.html)
7 changes: 5 additions & 2 deletions docs/book/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@
[Introduction](./introduction.md)
[Roadmap](./roadmap.md)
- [Topics](./topics/topics.md)
- [Getting Started](./topics/getting-started.md)
- [AAD Integration](./topics/aad-integration.md)
- [API Server Endpoint](./topics/api-server-endpoint.md)
- [Cloud Provider Config](./topics/cloud-provider-config.md)
- [Custom Private DNS Zone Name](./topics/custom-dns.md)
- [Custom Images](./topics/custom-images.md)
- [Data Disks](./topics/data-disks.md)
- [Ephemeral OS](./topics/ephemeral-os.md)
- [External Cloud Provider](./topics/external-cloud-provider.md)
- [Failure Domains](./topics/failure-domains.md)
- [GPU-enabled Clusters](./topics/gpu.md)
- [Identity](./topics/identity.md)
Expand All @@ -21,5 +22,7 @@
- [Node Ooutbound Load Balancer](./topics/node-outbound-lb.md)
- [Spot Virtual Machines](./topics/spot-vms.md)
- [Virtual Networks](./topics/custom-vnet.md)
- [Custom Private DNS Zone Name](./topics/custom-dns.md)
- [Windows](./topics/windows.md)
- [Development](./developers/development.md)
- [Kubernetes Developers](./developers/kubernetes-developers.md)
- [Releasing](./developers/releasing.md)
Loading