Merge pull request #11595 from hakman/cleanup-docs

Cleanup Docs
This commit is contained in:
Kubernetes Prow Robot 2021-05-25 00:22:22 -07:00 committed by GitHub
commit c01c565030
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 29 additions and 36 deletions

View File

@ -107,15 +107,15 @@ For a better viewing experience please check out our live documentation site at
## Development
* [Developing using Docker](development/Docker.md)
* [Documentation Guidelines](development/documentation.md)
* [E2E testing with `kops` clusters](development/testing.md)
* [Example on how to add a feature](development/adding_a_feature.md)
* [Hack Directory](development/hack.md)
* [How to update `kops` API](development/api_updates.md)
* [Low level description on how kops works](development/how_it_works.md)
* [Notes on Gossip design](development/gossip.md)
* [Notes on master instance sizing](development/instancesizes.md)
* [Our release process](development/release.md)
* [Releasing with Homebrew](development/homebrew.md)
* [Rolling Update Diagrams](development/rolling_update.md)
* [Developing using Docker](contributing/Docker.md)
* [Documentation Guidelines](contributing/documentation.md)
* [E2E testing with `kops` clusters](contributing/testing.md)
* [Example on how to add a feature](contributing/adding_a_feature.md)
* [Hack Directory](contributing/hack.md)
* [How to update `kops` API](contributing/api_updates.md)
* [Low level description on how kops works](contributing/how_it_works.md)
* [Notes on Gossip design](contributing/gossip.md)
* [Notes on master instance sizing](contributing/instancesizes.md)
* [Our release process](contributing/release.md)
* [Releasing with Homebrew](contributing/homebrew.md)
* [Rolling Update Diagrams](contributing/rolling_update.md)

View File

@ -2,7 +2,7 @@
Are you interested in contributing to kOps? We, the maintainers and community,
would love your suggestions, contributions, and help! We have a quick-start
guide on [adding a feature](../development/adding_a_feature.md). Also, the
guide on [adding a feature](adding_a_feature.md). Also, the
maintainers can be contacted at any time to learn more about how to get
involved.
@ -41,7 +41,7 @@ https://go.k8s.io/bot-commands).
kOps maintainers set aside one hour every other week for **public** office hours. This time is used to gather with community members interested in kOps. This session is open to both developers and users.
For more information, checkout the [office hours page.](office_hours.md)
For more information, checkout the [office hours page.](../welcome/office_hours.md)
### Other Ways to Communicate with the Contributors

View File

@ -11,10 +11,6 @@
The easiest way to get a production grade Kubernetes cluster up and running.
## 2020-05-06 etcd-manager Certificate Expiration Advisory
kops versions released today contain a **critical fix** to etcd-manager: 1 year after creation (or first adopting etcd-manager), clusters will stop responding due to expiration of a TLS certificate. Upgrading kOps to 1.15.3, 1.16.2, 1.17.0-beta.2, or 1.18.0-alpha.3 is highly recommended. Please see the [advisory](./advisories/etcd-manager-certificate-expiration.md) for the full details.
## What is kOps?
We like to think of it as `kubectl` for clusters.
@ -22,7 +18,7 @@ We like to think of it as `kubectl` for clusters.
`kops` will not only help you create, destroy, upgrade and maintain production-grade, highly
available, Kubernetes cluster, but it will also provision the necessary cloud infrastructure.
AWS (Amazon Web Services) is currently officially supported, with DigitalOcean, GCE, and OpenStack in beta support, and Azure and AliCloud in alpha.
[AWS](getting_started/aws.md) (Amazon Web Services) is currently officially supported, with [DigitalOcean](getting_started/digitalocean.md), [GCE](getting_started/gce.md), and [OpenStack](getting_started/openstack.md) in beta support, and [Azure](getting_started/azure.md) and AliCloud in alpha.
## Can I see it in action?
@ -35,15 +31,13 @@ AWS (Amazon Web Services) is currently officially supported, with DigitalOcean,
## Features
* Automates the provisioning of Kubernetes clusters in [AWS](getting_started/aws.md) and [GCE](getting_started/gce.md)
* Deploys Highly Available (HA) Kubernetes Masters
* Automates the provisioning of Highly Available Kubernetes clusters
* Built on a state-sync model for **dry-runs** and automatic **idempotency**
* Ability to generate [Terraform](terraform.md)
* Supports managed kubernetes [add-ons](addons.md)
* Supports **zero-config** managed kubernetes [add-ons](addons.md)
* Command line [autocompletion](cli/kops_completion.md)
* YAML Manifest Based API [Configuration](manifests_and_customizing_via_api.md)
* [Templating](operations/cluster_template.md) and dry-run modes for creating
Manifests
* Choose from eight different CNI [Networking](networking.md) providers out-of-the-box
* Supports upgrading from [kube-up](upgrade_from_kubeup.md)
* [Templating](operations/cluster_template.md) and dry-run modes for creating Manifests
* Choose from most popular CNI [Networking](networking.md) providers out-of-the-box
* Multi-architecture ready with ARM64 support
* Capability to add containers, as hooks, and files to nodes via a [cluster manifest](cluster_spec.md)

View File

@ -8,7 +8,7 @@ From Homebrew:
brew update && brew install kops
```
Developers can also easily install [development releases](development/homebrew.md).
Developers can also easily install [development releases](contributing/homebrew.md).
From Github:
@ -18,7 +18,7 @@ chmod +x ./kops
sudo mv ./kops /usr/local/bin/
```
You can also [install from source](development/building.md).
You can also [install from source](contributing/building.md).
## Linux
@ -30,7 +30,7 @@ chmod +x ./kops
sudo mv ./kops /usr/local/bin/
```
You can also [install from source](development/building.md).
You can also [install from source](contributing/building.md).
# Installing Other Dependencies

View File

@ -19,7 +19,7 @@ chmod +x ./kops
sudo mv ./kops /usr/local/bin/
```
You can also rerun [these steps](../development/building.md) if previously built from source.
You can also rerun [these steps](../contributing/building.md) if previously built from source.
### Linux
@ -32,7 +32,7 @@ chmod +x ./kops
sudo mv ./kops /usr/local/bin/
```
You can also rerun [these steps](../development/building.md) if previously built from source.
You can also rerun [these steps](../contributing/building.md) if previously built from source.
## Upgrading Kubernetes

View File

@ -12,8 +12,7 @@ Reworked SSH keys and support for running CI builds
do a rolling update when you would otherwise not have to. I suggest waiting till you next upgrade kubernetes.
* Builds that are not published as Docker images can be run. `kops` will pass a list of images in the NodeUp
configuration, and NodeUp will download and `docker load` these images. For examples, see the
[testing tips](../development/testing.md)
configuration and NodeUp will download and `docker load` these images.
## Jul 21 2016

View File

@ -12,7 +12,7 @@ By default, a cluster has:
because we need to force the cloud to run an instance in every zone, so we can mount the master volumes - we
cannot do that across zones.
This page explains some common instance group operations. For more detailed documentation of the various configuration keys, see the [InstanceGroup Resource](instancegroups_spec.md).
This page explains some common instance group operations. For more detailed documentation of the various configuration keys, see the [InstanceGroup Resource](../instance_groups.md).
## Instance Groups Disclaimer
@ -469,7 +469,7 @@ If you're running Kubernetes 1.6.0 or later, you can also control taints in the
The taints property takes a list of strings. The following example would add two taints to an IG,
using the same `edit` -> `update` -> `rolling-update` process as above.
Additionally, `nodeLabels` can be added to an IG in order to take advantage of Pod Affinity. Every node in the IG will be assigned the desired labels. For more information see the [labels](./labels.md) documentation.
Additionally, `nodeLabels` can be added to an IG in order to take advantage of Pod Affinity. Every node in the IG will be assigned the desired labels. For more information see the [labels](../labels.md) documentation.
```YAML
metadata:

View File

@ -136,7 +136,7 @@ nav:
- Contributing:
- Getting Involved and Contributing: "contributing/index.md"
- New Kubernetes Version: "contributing/new_kubernetes_version.md"
- Our Release Process: "contributing/release.md"
- Our Release Process: "contributing/release-process.md"
- Releasing With Homebrew: "contributing/homebrew.md"
- Updating The Default Base AMI: "contributing/update_ami_versions.md"
- Building: "contributing/building.md"