docs: small updates to machine charm tutorial #1583
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…o touched up language & formatting
…g in the note - probably more useful)
tonyandrewmeyer
approved these changes
Feb 26, 2025
| - Familiarity with Linux. | ||
| - Familiarity with the Python programming language, including Object-Oriented Programming and event handlers. | ||
|
|
||
| It will also help if you're familiar with Juju , but don't worry if you're new to Juju. This tutorial will guide you through each step. |
There was a problem hiding this comment.
Suggested change
| It will also help if you're familiar with Juju , but don't worry if you're new to Juju. This tutorial will guide you through each step. | |
| It will also help if you're familiar with Juju, but don't worry if you're new to Juju. This tutorial will guide you through each step. |
| 4. Let the model know the issue is resolved (fixed): `juju resolved microsample/0`. | ||
| If the Juju status doesn't look right, for example if you see an "error" status instead of "active", | ||
| there might be an issue with the charm code. You can use a debug session (`juju debug-log`) to look | ||
| for error reports from Python. After you've identified the issue: |
There was a problem hiding this comment.
"error reports from Python" doesn't seem right to me. I guess in some ways it's Python providing the error, but in other ways it's ops or Juju.
What about something like "to get more detailed information about the problem. After ..."?
There was a problem hiding this comment.
Nice suggestion, thanks! I've updated in 2e85081 (using "issue" instead of "problem" to stay consistent).
dwilding
force-pushed
the
update-machine-tutorial
branch
from
1d7beb5 to
2e85081
Compare
IronCore864
approved these changes
Feb 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is for capturing small updates to Write your first machine charm while I'm working on creating my own sample machine charm.
Summary of changes:
Adjusted the "What you'll need section" to tidy up the language & formatting, and to clarify that familiarity with Juju is not an absolute requirement.
When using
curlto test the service after the initial deployment, we don't need tojuju execinto the unit first. Instead, we can docurl http://10.122.219.101:8080, where 10.122.219.101 is the IP of the unit. I've updated the command and the preceding text to match.Added missing context to the note that comes after using
curlto test the service. This note was supposed to say that the reader should follow the four steps in case something went wrong after deploying the charm. I added this context.I also removed a commented-out part about inspecting hooks. In the newly-added context, I mention about
juju debug-log, which is probably more useful than inspecting hooks.Preview doc