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 to explain how the cluster-template can be edited #144

Merged
merged 1 commit into from
Jul 6, 2020
Merged

docs to explain how the cluster-template can be edited #144

merged 1 commit into from
Jul 6, 2020

Conversation

gianarb
Copy link
Contributor

@gianarb gianarb commented Jul 3, 2020

The workflow explained by cluster-api documentation and in our readme is
the basic one.

But you do not need to use the clusterctl config cluster command to
get cluster spec you need to create your workload.

You can write your own one or you can start from the template and modify
it based on your need.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 3, 2020
@k8s-ci-robot k8s-ci-robot added sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 3, 2020
@gianarb
Copy link
Contributor Author

gianarb commented Jul 3, 2020

/kind docs

@k8s-ci-robot
Copy link
Contributor

@gianarb: The label(s) kind/docs cannot be applied, because the repository doesn't have them

In response to this:

/kind docs

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@gianarb
Copy link
Contributor Author

gianarb commented Jul 3, 2020

/kind documentation

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 3, 2020
Copy link
Contributor

@deitch deitch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is nice, let's help customers.

I found a few typos. One other thing is that this doc is standalone. There is no link to it, so no hint from the main page that you can get there. Maybe put a link to it?

docs/experiences/custom-cluster-template.md Outdated Show resolved Hide resolved
docs/experiences/custom-cluster-template.md Outdated Show resolved Hide resolved
docs/experiences/custom-cluster-template.md Outdated Show resolved Hide resolved
docs/experiences/custom-cluster-template.md Outdated Show resolved Hide resolved
@gianarb
Copy link
Contributor Author

gianarb commented Jul 3, 2020

I found a few typos. One other thing is that this doc is standalone. There is no link to it, so no hint from the main page that you can get there. Maybe put a link to it?

Currently, there is not even a main page. I see them as a notes at this point that I hope we will figure out how to make together with the team

@deitch
Copy link
Contributor

deitch commented Jul 3, 2020

There is a section "Generate Your Cluster Yaml" on the README. A single line from that you can modify and generate your own and here is a link to a page describing how would do it.

@gianarb gianarb requested a review from deitch July 6, 2020 09:00
Copy link
Contributor

@deitch deitch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found one last type.

docs/experiences/custom-cluster-template.md Outdated Show resolved Hide resolved
The workflow explained by cluster-api documentation and in our readme is
the basic one.

But you do not need to use the `clusterctl config cluster` command to
get cluster spec you need to create your workload.

You can write your own one or you can start from the template and modify
it based on your need.
@deitch
Copy link
Contributor

deitch commented Jul 6, 2020

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: deitch, gianarb

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gianarb gianarb merged commit 8e5d9ee into kubernetes-sigs:master Jul 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants