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.

Sign up for GitHub

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

Jump to bottom

Fixing typos and rewording docs/examples/basic-requirements.md #9442

Merged
merged 3 commits into from
Jul 6, 2020
Merged

Fixing typos and rewording docs/examples/basic-requirements.md #9442

merged 3 commits into from
Jul 6, 2020

Conversation

moshevayner
Copy link
Member

No description provided.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 25, 2020
@moshevayner
Copy link
Member Author

/retest

olemarkus
olemarkus reviewed Jun 25, 2020
View reviewed changes
Copy link
Member

@olemarkus olemarkus left a comment

Choose a reason for hiding this comment

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

Looks better.
Not 100% sure what value this doc actually brings though.
Some of this can be linked to other docs like high availability, single-to-multimaster etc.

docs/examples/basic-requirements.md Outdated
@@ -42,18 +48,18 @@ yum -y install epel-release
yum -y install jq
```

**Debian7/Debian8/Debian9/Ubuntu1404lts/Ubuntu1604lts:**
**Debian 7/8/9, Ubuntu 14.04/16.04:**
Copy link
Member

Choose a reason for hiding this comment

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

Can probably drop versions here

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, good point.
I guess we can change that to **Debian 8/9/10, Ubuntu 16.04/18.04/20/04:**?

Copy link
Member Author

@moshevayner moshevayner Jun 29, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Bumped the versions to **Debian 9/10, Ubuntu 16.04/18.04/20.04:**
(Dropped debian 8 because it's EOL already)

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, @olemarkus I'm just re-reading your comment. Did you mean completely removing the versions and just keeping the distro names, so Debian/Ubuntu without specifying versions at all?

@moshevayner
Copy link
Member Author

Looks better.
Not 100% sure what value this doc actually brings though.
Some of this can be linked to other docs like high availability, single-to-multimaster etc.

Hmm, yeah I see your point. Although examples could be sometimes useful as a starting point for someone who hasn't used kops at all before. Perhaps it's worth adding another section under Getting Started for Examples?

hakman
hakman requested changes Jul 6, 2020
View reviewed changes
docs/examples/basic-requirements.md Outdated Show resolved Hide resolved
docs/examples/basic-requirements.md Outdated Show resolved Hide resolved
hakman
hakman requested changes Jul 6, 2020
View reviewed changes
docs/examples/basic-requirements.md Outdated Show resolved Hide resolved
docs/examples/basic-requirements.md Outdated Show resolved Hide resolved
hakman
hakman reviewed Jul 6, 2020
View reviewed changes
docs/examples/basic-requirements.md
@@ -33,27 +34,27 @@ export PATH=$PATH:~/bin
mv kubectl kops ~/bin
```

Finally, some of our exercises use the "jq" utility that is available on modern linux distributions. Please ensure to install it too. Some examples of how to do it:
Finally, some of our exercises use the `jq` utility which is available on modern linux distributions. Please ensure to [install](https://stedolan.github.io/jq/download/) it as well.
Copy link
Member

Choose a reason for hiding this comment

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

@MoShitrit could you also delete all the text below this line?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done 😄
Thanks for reviewing @hakman !

Copy link
Member

Choose a reason for hiding this comment

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

Np. Thanks for finding these.
@olemarkus does it look better now?

@olemarkus
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 6, 2020
@rifelpet
Copy link
Member

rifelpet commented Jul 6, 2020

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: MoShitrit, rifelpet

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 6, 2020
@k8s-ci-robot k8s-ci-robot merged commit 030b7dc into kubernetes:master Jul 6, 2020
@k8s-ci-robot k8s-ci-robot added this to the v1.19 milestone Jul 6, 2020
@moshevayner moshevayner deleted the docs-update branch July 6, 2020 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hakman hakman hakman requested changes

@olemarkus olemarkus olemarkus left review comments

@mikesplain mikesplain Awaiting requested review from mikesplain

@rdrgmnzs rdrgmnzs Awaiting requested review from rdrgmnzs

Assignees

@olemarkus olemarkus

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/documentation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v1.19
Development

Successfully merging this pull request may close these issues.
5 participants
@moshevayner @olemarkus @rifelpet @k8s-ci-robot @hakman