Separate documentation from the README #110
Conversation
Signed-off-by: Houston Putman <houstonputman@gmail.com>
Signed-off-by: Houston Putman <houstonputman@gmail.com>
Signed-off-by: Houston Putman <houstonputman@gmail.com>
| @@ -0,0 +1,233 @@ | |||
| # Solr on Kubernetes on local Mac | |||
There was a problem hiding this comment.
I commented on slack that I think this should be a more generalized example (i.e not specific to mac).
That would perhaps mean using minibike/k3d/KinD instead...
There was a problem hiding this comment.
Would definitely love to have documentations for all of those options!
Are you using any of those other providers? If so would you be willing to help out with those steps?
There was a problem hiding this comment.
I have continued to develop the initial tutorial into a lab for a training course. For that I added instructions for Windows (which is a big hassle tbh). Feel free to copy/paste something from here: https://gist.github.com/4bc3398822b8b68ec94c60a05474e409
Since it is not mac-only I do not assume brew or anything, but have included choco commands. Powershell / CMD is a mess, so I added separate examples for them. Can you imagine that Powershell has a default alias for curl to some internal cmdled, even if you have the real curl.exe on path. ;(
There was a problem hiding this comment.
That's great @janhoy!
I really wish there was a way in markdown to select an environment at the top and have that determine which example you saw. That would make the experience a whole lot cleaner.
|
Ok so since there are no issues with the content currently, I will merge this now. But I will also open another issue to support non-docker-for-mac use cases as well. It'll be easier to iterate on that as a smaller PR. |
Issue number of the reported bug or feature request: Resolves #105 and relates to #77
Describe your changes
I have created a documentation folder and split out a lot of the content from the top-level README into individual pages. I may have missed some stuff, but I think the majority has been put into better places.
I have also included the awesome tutorial provided by @janhoy. I tweaked this a bit, so I would definitely love additional comments.
The sections for each resource (SolrCloud, SolrCollection, etc) can definitely be improved, but I wanted to get this started first. Once we have the better layout, we can work on improving each section individually.
I would love as much feedback on this as possible before merging in, as it's a pretty dramatic change.