Skip to content

formatting: Use quote blocks & code blocks in "Code examples" #165

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.

Sign up for GitHub

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

Draft
MggMuggins wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

formatting: Use quote blocks & code blocks in "Code examples" #165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 34 additions & 33 deletions en/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,11 +308,11 @@ sections of code. They also encourage poor explanation of the code.

**DO NOT** use comments in normal bash code. E.g.:

```bash
juju deploy wordpress
juju deploy ntp-master --to 2 #colocates with wordpress
juju add-relation mysql wordpress
```
> ```bash
> juju deploy wordpress
> juju deploy ntp-master --to 2 #colocates with wordpress
> juju add-relation mysql wordpress
> ```

This may be a useful comment if you just have a bash script to communicate
information, but we have words! It is clearer, more obvious and more helpful
Expand All @@ -327,40 +327,41 @@ download instead.

**DO** separate commands and output where appropriate. For example, instead of:

```bash
juju status
environment: gce3
machines:
"0":
agent-state: started
agent-version: 1.24.2
dns-name: 104.197.44.114
...
...
```
> ```bash
> juju status
> environment: gce3
> machines:
> "0":
> agent-state: started
> agent-version: 1.24.2
> dns-name: 104.197.44.114
> ...
> ...
> ```

It is more informative to break between the command and the output
with explanation. This doesn't even have to be long. It breaks up the
code blocks somewhat and makes the whole document more legible and less
likely to cause unintended naps. For example

``` bash
To check what is going on, run:


juju status

... which should return some formatted information giving the current
state of each unit and service:

environment: gce3
machines:
"0":
agent-state: started
agent-version: 1.24.2
...
...
```
> To check what is going on, run:
>
> ```bash
> juju status
> ```
>
> ... which should return some formatted information giving the current
> state of each unit and service:
>
> ```yaml
> environment: gce3
> machines:
> "0":
> agent-state: started
> agent-version: 1.24.2
> ...
> ...
> ```

### Placeholders in code blocks

Expand Down