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
README: a significant rework #190
Conversation
This tries to massage the README into something more focused on the big picture, giving only a minimal introduction to the salient points, and linking off to other (TBD) resources for further information.
This will stay in draft until I've done the TBD docs. I might incorporate #135 into this as I go (if I do, this would supersede that). |
These won't live here! But it's a good place to stage them for now.
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.
I'd rather see the README changes land even if the rest hasn't yet, as I think it is still an improvement.
This reverts commit 06d242f.
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.
I don't think the recommendation actually works with the proposed directory layout. Otherwise I think this is still better than what we have.
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.
Awesome! Let's talk about referring to non-existant stuff in the docs... Thanks!
directory of your charm so it can be imported at run time: | ||
If you know about Juju, and have written charms that didn't use the operator | ||
framework (be it with reactive or without), we have an [introduction to the | ||
operator framework](/TBD) just for you. |
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.
Same than above.
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.
Great, thanks!!!
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.
I don't think there are any outright lies in this, though a couple of omissions that we'll want to fix as quickly as we can.
This tries to massage the README into something more focused on the
big picture, giving only a minimal introduction to the salient points,
and linking off to other (TBD) resources for further information.