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

Add doc on how to change an machine's series #2045

Merged
merged 2 commits into from
Oct 5, 2017

Conversation

hmlanigan
Copy link
Member

to Getting things done.

Copy link

@pmatulis pmatulis left a comment

Choose a reason for hiding this comment

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

Thanks for this. 🍰

Review:

  • Some general guidelines are included that need to be applied.
  • It's not obvious what is meant by "updating a machine series". At least one sentence should "set the stage".
  • I'm left wondering how to update a machine series from 2.3 onward.


This guide will cover how to do this prior to juju 2.3

!!! Note: charms may have to be updated to take advantage series info change.
Copy link

Choose a reason for hiding this comment

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

Notes should be in the format below. I've also reworded. Does it still make sense (I'm not sure)?

!!! Note:
    Charms may have to be updated in order to take advantage of a series change.

Copy link
Member Author

Choose a reason for hiding this comment

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

change made. 'upgraded' used instead as that is closer to the related juju command.


```
$ juju switch localhost-test:admin/default
```
Copy link

Choose a reason for hiding this comment

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

We use syntax highlighting using a "type" with 'bash', 'yaml', 'json', and 'no-highlight' being the most common. We also do not include the prompt.

```bash
juju switch localhost-test:admin/default
```

We also separate input from output. Typically the output (which uses the 'no-highlight' type) is prepended by something like:

This will give output closely resembling:

Try being creative with the above. It gets tiresome really quickly by using the same everywhere. An option is to sometimes include the command (if it's simple like juju status for example) within the preceding text itself (e.g. "Output to the juju status command will look like:").

Copy link
Member Author

Choose a reason for hiding this comment

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

Added the highlighting types. Tried to make the output more interesting?

@hmlanigan hmlanigan changed the base branch from master to 2.2 October 4, 2017 18:30
@hmlanigan
Copy link
Member Author

moved to 2.2 and updated title to match pr 2019.

@evilnick evilnick merged commit bb20ea1 into juju:2.2 Oct 5, 2017
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