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

README: a significant rework #190

Merged
merged 12 commits into from May 18, 2020
Merged

README: a significant rework #190

merged 12 commits into from May 18, 2020

Conversation

chipaca
Copy link
Contributor

@chipaca chipaca commented Mar 26, 2020

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 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.
@chipaca
Copy link
Contributor Author

chipaca commented Mar 26, 2020

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).

README.md Outdated Show resolved Hide resolved
These won't live here! But it's a good place to stage them for now.
Copy link
Member

@jameinel jameinel left a 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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@chipaca chipaca marked this pull request as ready for review May 13, 2020 14:26
Copy link
Member

@jameinel jameinel left a 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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@facundobatista facundobatista left a 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!

README.md Show resolved Hide resolved
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same than above.

Copy link
Contributor

@facundobatista facundobatista left a comment

Choose a reason for hiding this comment

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

Great, thanks!!!

Copy link
Member

@jameinel jameinel left a 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.

@chipaca chipaca merged commit fd728bc into canonical:master May 18, 2020
@chipaca chipaca deleted the docs-take-2 branch May 18, 2020 16:51
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.

None yet

3 participants