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

docs: update logo and readme #1571

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

tmihoc
Copy link
Member

@tmihoc tmihoc commented Feb 6, 2025

This PR

  • updates the logo from the default circle of friends to the juju logo
  • updates the README to point to the new docs

Copy link
Contributor

@tonyandrewmeyer tonyandrewmeyer left a comment

Choose a reason for hiding this comment

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

Logo change looks good. @tmihoc there's no change to the readme, did you miss committing a file maybe?

README.md Outdated
- Read our [codebase contributor guidelines](https://github.com/canonical/operator/blob/main/HACKING.md) and help improve the codebase
- Write a charm and publish it on [Charmhub](https://charmhub.io/)
- Read the [docs](https://ops.readthedocs.io/en/latest/)
- Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) join our [chat](https://matrix.to/#/#charmhub-ops:ubuntu.com) and [forum](https://discourse.charmhub.io/) or [open an issue](https://github.com/canonical/operator/issues)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) join our [chat](https://matrix.to/#/#charmhub-ops:ubuntu.com) and [forum](https://discourse.charmhub.io/) or [open an issue](https://github.com/canonical/operator/issues)
- Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct), join our [chat](https://matrix.to/#/#charmhub-ops:ubuntu.com) and [forum](https://discourse.charmhub.io/), or [open an issue](https://github.com/canonical/operator/issues)

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated.

- Join our chat: [Mattermost](https://chat.charmhub.io/charmhub/channels/ops)
- Join our forum: [Discourse](https://discourse.charmhub.io/)

### File an issue
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the reason for removing these links? Obviously the doc one needs to be collapsed into the first point rather than pointing to Juju (which probably hasn't been the thing to do for some time...) but I think there's value in having this. If you're reading this on GitHub it's somewhat obvious that there is an issues tab (but it doesn't hurt to be explicit), and on PyPI there is an "issues" link but this spells it out more clearly, and if you only have the dist, then the is the only link in the readme to GitHub I think.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think these are moved to the bottom, 3 links on one line; so not totally removed.

Copy link
Member Author

Choose a reason for hiding this comment

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

All this info is now given more compatible direct after Next steps. We don't have as many links anymore. (E.g., there's no separate docs vs. API reference.

Copy link
Contributor

@dimaqq dimaqq left a comment

Choose a reason for hiding this comment

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

I see that juju-logo-no-text.png is used, but juju-logo{light,dark}{png,svg} are not used.

If the files are unused, please remove them.

@tmihoc
Copy link
Member Author

tmihoc commented Feb 7, 2025

I see that juju-logo-no-text.png is used, but juju-logo{light,dark}{png,svg} are not used.

If the files are unused, please remove them.

Done.

@tmihoc
Copy link
Member Author

tmihoc commented Feb 7, 2025

/merge

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