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

Updated docs #67

Merged
merged 9 commits into from
Nov 30, 2017
Merged

Updated docs #67

merged 9 commits into from
Nov 30, 2017

Conversation

vikram-bitnami
Copy link
Contributor

No description provided.

README.md Outdated
cd $working_dir
git clone https://github.com/kubeapps/kubeapps
minikube start
sudo curl -s https://api.github.com/repos/kubeapps/kubeapps/releases/latest | grep linux | grep browser_download_url | cut -d '"' -f 4 | wget -i -
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm using this so the user always gets the latest release, rather than having the command hardcoded to a specific version (so there's less need to update it every time). I got the command from https://gist.github.com/steinwaywhw/a4cd19cda655b8249d908261a62687f8 and tested it, seems to work fine but please also test it yourself.

Copy link
Contributor

Choose a reason for hiding this comment

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

Well, this is about building the latest source. For documentation on how to use, we have the rest of the documents. Please, leave here the documentation on how to build. Also, please, avoid having explicit reference to minikube on the docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added back in README, removed minikube commands

Copy link
Contributor

@arapulido arapulido left a comment

Choose a reason for hiding this comment

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

Thanks for this! I have added some comments, can you review them, please? Thanks!

README.md Outdated
cd $working_dir
git clone https://github.com/kubeapps/kubeapps
minikube start
sudo curl -s https://api.github.com/repos/kubeapps/kubeapps/releases/latest | grep linux | grep browser_download_url | cut -d '"' -f 4 | wget -i -
Copy link
Contributor

Choose a reason for hiding this comment

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

Well, this is about building the latest source. For documentation on how to use, we have the rest of the documents. Please, leave here the documentation on how to build. Also, please, avoid having explicit reference to minikube on the docs.

README.md Outdated

```
cd kubeapps
make binary
minikube start
Copy link
Contributor

Choose a reason for hiding this comment

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

Same thing as above. Let's keep building the tool here, and point people to the Getting started for the rest. Also you can put it here as well if you want to, but please, let's keep the building instructions somewhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added back in README

README.md Outdated
cd kubeapps
make binary
minikube start
sudo curl -s https://api.github.com/repos/kubeapps/kubeapps/releases/latest | grep darwin | grep browser_download_url | cut -d '"' -f 4 | wget -i -
Copy link
Contributor

Choose a reason for hiding this comment

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

if we add instructions about MacOs, then we need for Linux and Windows as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to only include Linux instructions and marked as example

@@ -0,0 +1,84 @@
# Get Started with Kubeapps
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we avoid changing the filenames (i.e. getting-started -> get-started.md) if not critical, please? Easier to review and it won't break the links in kubeapps.com

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

@arapulido arapulido left a comment

Choose a reason for hiding this comment

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

Small typo. Other than that, looks good to me.

README.md Outdated
- Download the most recent Go version (here we used 1.9) and unpack the file
- Check the installation process on https://golang.org/doc/install
- Set the Go environment variables
To remove Kubeapps form your cluster, simply run:
Copy link
Contributor

Choose a reason for hiding this comment

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

s/form/from/

@ngtuna ngtuna merged commit 956adda into vmware-tanzu:master Nov 30, 2017
prydonius pushed a commit to prydonius/kubeapps that referenced this pull request Mar 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants