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

Better turorial for getting started #105

Closed
janhoy opened this issue Apr 2, 2020 · 1 comment · Fixed by #110
Closed

Better turorial for getting started #105

janhoy opened this issue Apr 2, 2020 · 1 comment · Fixed by #110

Comments

@janhoy
Copy link
Contributor

janhoy commented Apr 2, 2020

Is your feature request related to a problem? Please describe.
I got stuck several times in setting up the operator, as the README goes straight into building from source and it is a bit unclear what happens.

Describe the solution you'd like
The first steps in README should not be building it from source but installing with as few steps as possible, whether using helm or directly with kubectl apply some combined yaml that gets everything setup (like for dependencies)

So when testing this out for myself, I created kind of a tutorial that is what I'd like to have seen when visiting the repo myself. It takes you through setting up your environment (Mac only) with ingress controller, k8s dashboard and Solr install, scale, upgrade and delete. The tutorial is in this gist, feel free to steal it or parts of it into a Wiki page or something in this repo.

https://gist.github.com/19bd70ab4ecbcc35eeaecfbc63fbbe1c

@HoustonPutman
Copy link
Contributor

This is awesome. The readme has basically been made from my perspective, which is definitely the wrong way to go about it. I think this is an opportune time to shorten the readme and make it more geared towards new users. We can then move a lot of other content into more specific documentation files.

I can start on something this weekend and make a PR. Thanks so much for getting this started, it's long overdue.

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 a pull request may close this issue.

2 participants