-
Notifications
You must be signed in to change notification settings - Fork 772
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
Add setup.md #546
Conversation
This is creating duplication with README.md 😏 |
@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. |
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 :-( |
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 |
@kadel Yup, that's what I meant. In the README.md we'll have our recommend way (installation via binary), in the |
@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) |
There was a problem hiding this 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) |
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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).
@kadel updated! |
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).