Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: use MaintenanceStatus for local issues #1397

Merged

Conversation

tonyandrewmeyer
Copy link
Contributor

WaitingStatus should be used when waiting on an integrated charm. MaintenanceStatus should be used when waiting for something local to the charm. We missed an example in can_connect() when clarifying the statuses earlier in the year.

@tonyandrewmeyer tonyandrewmeyer changed the title doc: use MaintenanceStatus for local issues docs: use MaintenanceStatus for local issues Sep 26, 2024
Copy link
Contributor

@james-garner-canonical james-garner-canonical left a comment

Choose a reason for hiding this comment

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

Makes sense, and this is just changing the example in the docs to reflect what's recommended and used elsewhere.

@tonyandrewmeyer tonyandrewmeyer merged commit ce62847 into canonical:main Sep 27, 2024
30 of 31 checks passed
@tonyandrewmeyer tonyandrewmeyer deleted the correct-pebble-status-doc branch September 27, 2024 00:10
tonyandrewmeyer added a commit to tonyandrewmeyer/operator that referenced this pull request Oct 4, 2024
`WaitingStatus` should be used when waiting on an integrated charm.
`MaintenanceStatus` should be used when waiting for something local to
the charm. We missed an example in `can_connect()` when clarifying the
statuses earlier in the year.
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants