Skip to content

Commit 86888c1

Browse files
More CONTRIBUTING.md updates
(cherry picked from commit 51c8648)
1 parent c62e98f commit 86888c1

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,24 @@ gmake ct-unit_log_management
5252
## Running Single Nodes from Source
5353

5454
``` shell
55-
# starts a node with the management plugin enabled
55+
# Run from repository root.
56+
# Starts a node with the management plugin enabled
5657
gmake run-broker RABBITMQ_PLUGINS=rabbitmq_management
5758
```
5859

5960
The nodes will be started in the background. They will use `rabbit@{hostname}` for its name, so CLI will be able to contact
60-
it without an explicit `-n` (`--node`) argument.
61+
it without an explicit `-n` (`--node`) argument:
62+
63+
```shell
64+
# Run from repository root.
65+
./sbin/rabbitmq-diagnostics status
66+
```
6167

6268
## Running Clusters from Source
6369

6470
``` shell
65-
# starts a three node cluster with the management plugin enabled
71+
# Run from repository root.
72+
# Starts a three node cluster with the management plugin enabled
6673
gmake start-cluster NODES=3 RABBITMQ_PLUGINS=rabbitmq_management
6774
```
6875

@@ -81,17 +88,20 @@ epmd -names
8188
```
8289

8390
``` shell
84-
# makes CLI tools talk to node rabbit-2
85-
rabbitmq-diagnostics cluster_status -n rabbit-2
91+
# Run from repository root.
92+
# Makes CLI tools talk to node rabbit-2
93+
sbin/rabbitmq-diagnostics cluster_status -n rabbit-2
8694

87-
# makes CLI tools talk to node rabbit-1
88-
rabbitmq-diagnostics status -n rabbit-1
95+
# Run from repository root.
96+
# Makes CLI tools talk to node rabbit-1
97+
sbin/rabbitmq-diagnostics status -n rabbit-1
8998
```
9099

91100
To stop a previously started cluster:
92101

93102
``` shell
94-
# stops a three node cluster started earlier
103+
# Run from repository root.
104+
# Stops a three node cluster started earlier
95105
gmake stop-cluster NODES=3
96106
```
97107

0 commit comments

Comments
 (0)