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

Docs cleanup / mkdocs migration #7593

Merged
merged 8 commits into from
Oct 25, 2019
Merged
Show file tree
Hide file tree
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 Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -847,14 +847,20 @@ prow-postsubmit: bazel-version-dist

.PHONY: live-docs
live-docs:
@docker build --pull -t kops/mkdocs images/mkdocs
@docker build -t kops/mkdocs images/mkdocs
@docker run --rm -it -p 3000:3000 -v ${PWD}:/docs kops/mkdocs

.PHONY: build-docs
build-docs:
@docker build --pull -t kops/mkdocs images/mkdocs
@docker run --rm -v ${PWD}:/docs kops/mkdocs build

# TODO: Remove before merging
.PHONY: build-docs-netlify
build-docs-netlify:
@pip install -r ${MAKEDIR}/images/mkdocs/requirements.txt
@mkdocs build

# Update machine_types.go
.PHONY: update-machine-types
update-machine-types:
Expand Down
6 changes: 3 additions & 3 deletions README-ES.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ en alpha, y otras plataformas planeadas.

## Lanzando un anfitrión de Kubernetes cluster en AWS o GCE

Para reproducir exactamente el demo anterior, visualizalo en el [tutorial](/docs/aws.md) para
Para reproducir exactamente el demo anterior, visualizalo en el [tutorial](/docs/getting_started/aws.md) para
lanzar un anfitrión de Kubernetes cluster en AWS.

Para instalar un Kubernetes cluster en GCE por fabor siga esta [guide](/docs/tutorial/gce.md).
Para instalar un Kubernetes cluster en GCE por fabor siga esta [guide](/docs/getting_started/gce.md).


## Caracteristicas

* Automatiza el aprovisionamiento de Kubernetes clusters en [AWS](/docs/aws.md) y [GCE](/docs/tutorial/gce.md)
* Automatiza el aprovisionamiento de Kubernetes clusters en [AWS](/docs/getting_started/aws.md) y [GCE](/docs/getting_started/gce.md)
* Un Despliegue Altamente Disponible (HA) Kubernetes Masters
* Construye en un modelo de estado sincronizado para **dry-runs** y **idempotency** automático
* Capacidad de generar [Terraform](/docs/terraform.md)
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ in alpha, and other platforms planned.

## Launching a Kubernetes cluster hosted on AWS, GCE, DigitalOcean or OpenStack

To replicate the above demo, check out our [tutorial](/docs/aws.md) for
To replicate the above demo, check out our [tutorial](/docs/getting_started/aws.md) for
launching a Kubernetes cluster hosted on AWS.

To install a Kubernetes cluster on GCE please follow this [guide](/docs/tutorial/gce.md).
To install a Kubernetes cluster on GCE please follow this [guide](/docs/getting_started/gce.md).

To install a Kubernetes cluster on DigitalOcean, follow this [guide](/docs/tutorial/digitalocean.md).

Expand All @@ -45,7 +45,7 @@ To install a Kubernetes cluster on OpenStack, follow this [guide](/docs/tutorial

## Features

* Automates the provisioning of Kubernetes clusters in [AWS](/docs/aws.md), [OpenStack](/docs/tutorial/openstack.md) and [GCE](/docs/tutorial/gce.md)
* Automates the provisioning of Kubernetes clusters in [AWS](/docs/getting_started/aws.md), [OpenStack](/docs/getting_started/openstack.md) and [GCE](/docs/getting_started/gce.md)
* Deploys Highly Available (HA) Kubernetes Masters
* Built on a state-sync model for **dry-runs** and automatic **idempotency**
* Ability to generate [Terraform](/docs/terraform.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ arrange:
- examples
- tutorial
- releases
- aws.md
- getting_started/aws.md
28 changes: 17 additions & 11 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,33 @@
# Documentation Index

## Quick start
* [Getting started on AWS](aws.md)
* [Getting started on GCE](tutorial/gce.md)
* [Getting started on AWS](getting_started/aws.md)
* [Getting started on GCE](getting_started/gce.md)
* [CLI reference](cli/kops.md)


## Overview

* [Command-line interface](#command-line-interface)
* [Inspection](#inspection)
* [`kops` design documents](#kops-design-documents)
* [Networking](#networking)
* [Operations](#operations)
* [Security](#security)
* [Development](#development)
- [Documentation Index](#documentation-index)
- [Quick start](#quick-start)
- [Overview](#overview)
- [Command-line interface](#command-line-interface)
- [Advanced / Detailed List of Configurations](#advanced--detailed-list-of-configurations)
- [API / Configuration References](#api--configuration-references)
- [API Usage Guides](#api-usage-guides)
- [Operations](#operations)
- [Networking](#networking)
- [`kops` design documents](#kops-design-documents)
- [Security](#security)
- [Inspection](#inspection)
- [Development](#development)


## Command-line interface

* [CLI argument explanations](arguments.md)
* [CLI reference](cli/kops.md)
* [Commands](commands.md)
* [Commands](usage/commands.md)
* miscellaneous CLI-related remarks
* [Experimental features](experimental.md)
* list of and how to enable experimental flags in the CLI
Expand All @@ -46,7 +52,7 @@
* [Cluster addons](addons.md)
* [Cluster configuration management](changing_configuration.md)
* [Cluster desired configuration creation from template](cluster_template.md)
* [Cluster upgrades and migrations](cluster_upgrades_and_migrations.md)
* [Cluster upgrades and migrations](operations/cluster_upgrades_and_migrations.md)
* [`etcd` volume encryption setup](etcd_volume_encryption.md)
* [`etcd` backup/restore](etcd/backup-restore.md)
* [GPU setup](gpu.md)
Expand Down
155 changes: 0 additions & 155 deletions docs/addons.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/download_config.md → docs/advanced/download_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ kops create cluster $NAME \

You can simply use the kops command `kops get --name $NAME -o yaml > a_fun_name_you_will_remember.yml`

Note: for the above command to work the cluster NAME and the KOPS_STATE_STORE will have to be exported in your environment.
Note: for the above command to work the cluster NAME and the KOPS_STATE_STORE will have to be exported in your environment.

For more information on how to use and modify the configurations see [here](manifests_and_customizing_via_api.md).
For more information on how to use and modify the configurations see [here](../manifests_and_customizing_via_api.md).

## Managing instance groups

Expand Down
2 changes: 1 addition & 1 deletion docs/experimental.md → docs/advanced/experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ The following experimental features are currently available:
* `+EnableSeparateConfigBase` - Allow a config-base that is different from the state store.
* `+SpecOverrideFlag` - Allow setting spec values on `kops create`.
* `+ExperimentalClusterDNS` - Turns off validation of the kubelet cluster dns flag.
* `+EnableNodeAuthorization` - Enable support of Node Authorization, see [node_authorization.md](node_authorization.md).
* `+EnableNodeAuthorization` - Enable support of Node Authorization, see [node_authorization.md](../node_authorization.md).
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ data:

### Creating a new cluster with IAM Authenticator on.

* Create a cluster following the [AWS getting started guide](https://github.com/kubernetes/kops/blob/master/docs/aws.md)
* Create a cluster following the [AWS getting started guide](https://github.com/kubernetes/kops/blob/master/docs/getting_started/aws.md)
* When you reach the "Customize Cluster Configuration" section of the guide modify the cluster spec and add the Authentication and Authorization configs to the YAML config.
* Continue following the cluster creation guide to build the cluster.
* :warning: When the cluster first comes up the aws-iam-authenticator PODs will be in a bad state.
Expand Down
Loading