Lint and re-structure documentation #159
Conversation
|
|
docs/usage/machine.md
Outdated
| - Similarily `kubernetes/aws-machine-class.yaml` secret name and namespace should be same as that mentioned in `kubernetes/aws-secret.yaml` | ||
| ## Important :warning | ||
|
|
||
| > Make sure that the `kubernetes/machines_sets_deployments/machine.yaml` points to the same class name as the `kubernetes/machine_classes/aws-machine-class.yaml`. |
There was a problem hiding this comment.
Maybe we could rename kubernetes/machines_sets_deployments to kubernetes/machine_objects? does that make it more meaningful?
There was a problem hiding this comment.
Yes it makes sense, I just thought that for ease of access we include the type of the objects in the name but it turned out to be a long one.
There was a problem hiding this comment.
Thanks for the changes.
zanetworker
force-pushed
the
feature.restructure-docs
branch
from
5f95ff9 to
5fb34ef
Compare
There was a problem hiding this comment.
LGTM. @hardikdr you could take a quick look before merging it.
docs/deployment/kubernetes.md
Outdated
| - [Deploying the Machine Controller Manager into a Kubernetes cluster](#deploying-the-machine-controller-manager-into-a-kubernetes-cluster) | ||
| - [Prepare the cluster](#prepare-the-cluster) | ||
| - [Build the Docker image](#build-the-docker-image) | ||
| - [Configuring optional paramaters while deploying](#configuring-optional-paramaters-while-deploying) |
docs/design/README.md
Outdated
| - [Components of Machine Controller Manager](#components-of-machine-controller-manager) | ||
| - [Future Plans](#future-plans) | ||
| - [Todos Doc](#todos-doc) | ||
| - [Limitations](#limitations) |
There was a problem hiding this comment.
I think the limitations are not valid anymore, can you please remove them in this PR itself.
@prashanth26 what say ?
| @@ -1,55 +1,74 @@ | |||
| # Excess Reserve Capacity - WIP | |||
There was a problem hiding this comment.
This is not WIP anymore, I forgot to remove it later. Can you please use this PR remove WIP tag.
docs/usage/machine_set.md
Outdated
|
|
||
| - [Maintaining machine replicas using machines-sets](#maintaining-machine-replicas-using-machines-sets) | ||
| - [Setting up your usage environment](#setting-up-your-usage-environment) | ||
| - [Important :warning](#important-warning) |
There was a problem hiding this comment.
Is this a typo: warning is not resolved to the symbol
docs/usage/machine_set.md
Outdated
|
|
||
| > Make sure that the `kubernetes/machines_sets_deployments/machine-set.yaml` points to the same class name as the `kubernetes/machine_classes/aws-machine-class.yaml`. | ||
|
|
||
| > Similarily `kubernetes/machine_classes/aws-machine-class.yaml` secret name and namespace should be same as that mentioned in `kubernetes/secrets/aws-secret.yaml` |
There was a problem hiding this comment.
Name of the actual folder is Secrets - can we change it to secrets
docs/usage/machine_set.md
Outdated
| ```bash | ||
| $ kubectl apply -f kubernetes/machine-set.yaml | ||
| $ kubectl apply -f kubernetes/machines_sets_deployments/machine-set.yaml |
There was a problem hiding this comment.
I can still see occurrences of machines_sets_- which I guess is not aligned with actual folder-structure. Can you please change the necessary occurrences.
docs/usage/prerequisite.md
Outdated
| - Run the Machine Controller Manager either as described in [Setting up a local development environment](../development/local_setup.md) or [Deploying the Machine Controller Manager into a Kubernetes cluster](../deployment/kubernetes.md). | ||
| - Make sure that the following steps are run before managing machines/ machine-sets/ machine-deploys. | ||
| <!-- /TOC --> | ||
| ## Important :warning |
There was a problem hiding this comment.
Should it be resolved to the warning symbol ?
zanetworker
force-pushed
the
feature.restructure-docs
branch
from
5fb34ef to
0392f12
Compare
This pull request restructures documentation under the "docs" package and restructure the yaml files based on their intent (e.g., under machine_classes, secrets, or machines_sets_deployments)
zanetworker
force-pushed
the
feature.restructure-docs
branch
from
0392f12 to
a83dd89
Compare
|
@hardikdr and @prashanth26 thanks for reviewing, I have adjusted the docs based on your comments. |
What this PR does / why we need it:
This pull request restructures documentation under the "docs" package
and restructure the yaml files based on their intent (e.g., under
machine_classes, secrets, or machines_sets_deployments)
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Release note: