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

Add initial sections for docs site #102

Merged
merged 1 commit into from
Aug 5, 2020

Conversation

andrewsykim
Copy link
Member

@andrewsykim andrewsykim commented May 22, 2020

Signed-off-by: Andrew Sy Kim [email protected]

What type of PR is this?
/kind documentation

What this PR does / why we need it:
We're trying to improve documentation on the AWS cloud provider. Before divvying up the work, I would like agreement on what the content should look like at a high level. I've added some initial sections that I think is worth covering, I'd like to use this PR to discuss what other content we should include.

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

Signed-off-by: Andrew Sy Kim <[email protected]>
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 22, 2020
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 22, 2020
@randomvariable
Copy link
Member

lgtm as a skeleton to fill in.

* [Prerequisites](prerequisites.md)
* [Getting Started](getting_started.md)
* [Service LoadBalancers](service_loadbalancers.md)
* [Known Limitations](known_limitations.md)
Copy link
Member Author

Choose a reason for hiding this comment

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

What else do we need to add here?

Copy link
Member

Choose a reason for hiding this comment

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

EBS is going off to CSI now?
IAM perms is usually the key thing.

Copy link
Member

@randomvariable randomvariable May 22, 2020

Choose a reason for hiding this comment

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

Actually, any default tags the CPI set might be helpful to document.

Copy link
Member Author

@andrewsykim andrewsykim May 22, 2020

Choose a reason for hiding this comment

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

IAM perms is usually the key thing.

Agreed, I think this would go into the Prerequisites section I imagine

Copy link
Member Author

@andrewsykim andrewsykim May 22, 2020

Choose a reason for hiding this comment

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

Actually, any default tags the CPI set might be helpful to document.

Wondering what section this would belong to. Maybe a "Resource Management" section?

Copy link
Member

Choose a reason for hiding this comment

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

sgtm

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want node specific stuff in these docs too? We could have a section on the registry credential provider stuff. Also kubelet's interaction with the cloud provider, including node names, hostname override.

Copy link
Member Author

Choose a reason for hiding this comment

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

+1 for a section on Nodes. Will add it shortly

@andrewsykim
Copy link
Member Author

/hold

Pending discussion on doc template

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 22, 2020
@andrewsykim
Copy link
Member Author

/assign @justinsb @nckturner

@andrewsykim andrewsykim changed the title [WIP] initial template for docs site [WIP] add initial sections for docs site May 22, 2020
@nckturner
Copy link
Contributor

Let's merge this so we can start adding to it.

@nckturner
Copy link
Contributor

/hold cancel
/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Aug 5, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andrewsykim, nckturner

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:
  • OWNERS [andrewsykim,nckturner]

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

@nckturner nckturner changed the title [WIP] add initial sections for docs site Add initial sections for docs site Aug 5, 2020
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 5, 2020
@k8s-ci-robot k8s-ci-robot merged commit 2cfd6f6 into kubernetes:master Aug 5, 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. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants