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 setup.md #546

Merged
merged 1 commit into from
Apr 10, 2017
Merged

Add setup.md #546

merged 1 commit into from
Apr 10, 2017

Conversation

cdrage
Copy link
Member

@cdrage cdrage commented Apr 5, 2017

Adds setup.md to the docs folder in order to sync with changes to
http://kompose.io site (whenever we update setup.md here, it'll update
on the gh-pages branch).

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 5, 2017
@kadel
Copy link
Member

kadel commented Apr 6, 2017

This is creating duplication with README.md 😏
How we are going to keep those in sync?

@cdrage
Copy link
Member Author

cdrage commented Apr 6, 2017

@kadel Yup, it's a duplication of README.md which is edited when we do a release (version change).

The doc syncs with the setup.md in gh-pages as well.

Yes, we need to update README.md to reflect the new doc.

@kadel
Copy link
Member

kadel commented Apr 6, 2017

I meant how we are going to keep setup.md and readme in sync.

Its going to be hard to maintain install instruction in two places :-(
We are already bad in keeping docs up to date and remembering it to edit it in two places will just add to it :-(

@kadel
Copy link
Member

kadel commented Apr 6, 2017

It is better to have install instruction in readme, but rather that having it in two places we could just link to setup.md from readme

@cdrage
Copy link
Member Author

cdrage commented Apr 6, 2017

@kadel Yup, that's what I meant. In the README.md we'll have our recommend way (installation via binary), in the docs section, we'll have the elaborate way (CentOS, Fedora, etc.) as we get more packaging and other installation methods added.

@cdrage
Copy link
Member Author

cdrage commented Apr 7, 2017

@kadel Ready for review, I ended up re-working the installation methods on our README.md to emphasize binary installation as well as have the setup.md document list all of our installation methods (much cleaner than our current README)

Copy link
Member

@kadel kadel left a comment

Choose a reason for hiding this comment

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

just one small nitpick 👼
it would be nice to link to specific section in setup.md

README.md Outdated

Installation methods:
- [Binary (Prefered method)](README.md)
- [Go](/docs/setup.md)
Copy link
Member

Choose a reason for hiding this comment

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

/docs/setup.md#go

README.md Outdated
Installation methods:
- [Binary (Prefered method)](README.md)
- [Go](/docs/setup.md)
- [CentOS](/docs/setup.md)
Copy link
Member

Choose a reason for hiding this comment

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

/docs/setup.md#centos

README.md Outdated
- [Binary (Prefered method)](README.md)
- [Go](/docs/setup.md)
- [CentOS](/docs/setup.md)
- [Fedora](/docs/setup.md)
Copy link
Member

Choose a reason for hiding this comment

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

/docs/setup.md#fedora

README.md Outdated
- [Go](/docs/setup.md)
- [CentOS](/docs/setup.md)
- [Fedora](/docs/setup.md)
- [macOS (Homebrew)](/docs/setup.md)
Copy link
Member

Choose a reason for hiding this comment

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

/docs/setup.md#mac-os-x

Adds setup.md to the docs folder in order to sync with changes to
http://kompose.io site (whenever we update setup.md here, it'll update
on the gh-pages branch).
@cdrage
Copy link
Member Author

cdrage commented Apr 10, 2017

@kadel updated!

@kadel kadel merged commit 8c81708 into kubernetes:master Apr 10, 2017
@cdrage cdrage deleted the add-setup-doc branch April 19, 2017 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants