Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kajes committed Sep 13, 2024
1 parent e440946 commit c41e0a4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/sdpctl_sites_list.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ <h1 class="margin-top-small">sdpctl Reference Guide</h1>
</div>
<hr />
<div class="content text-left">
<h2 class="text-left margin-bottom">sdpctl sites list</h2><p>List and see status of sites of a collective</p><pre class="code-editor margin-bottom"><code>sdpctl sites list [&lt;site-id|site-name&gt;]... [flags]
<h2 class="text-left margin-bottom">sdpctl sites list</h2><p>List and see status of sites of a collective</p><hr class="margin-bottom"><h3 class="emphasize text-left margin-bottom-small">Synopsis</h3><p>List and see status of sites of a collective. By default, configured sites will be shown in a table, but viewing sites in json format is supported using the &lsquo;&ndash;json&rsquo; flag.
Text lines that contain multiple lines will be abbreviated to only showing the first line in the table view. In that case, the abbreviated lines will be indicated with &lsquo;[&hellip;]&rsquo;.
To view the full output, use the &lsquo;&ndash;json&rsquo; flag.</p><pre class="code-editor margin-bottom"><code>sdpctl sites list [&lt;site-id|site-name&gt;]... [flags]
</code></pre>
<hr class="margin-bottom"><h3 class="emphasize text-left margin-bottom-small">Examples</h3>
<pre class="code-editor margin-bottom"><code> # will list all sites configured in a collective if no arguments are used.
Expand Down
3 changes: 3 additions & 0 deletions pkg/docs/sites.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ var (
}
SitesListDocs = CommandDoc{
Short: "List and see status of sites of a collective",
Long: `List and see status of sites of a collective. By default, configured sites will be shown in a table, but viewing sites in json format is supported using the '--json' flag.
Text lines that contain multiple lines will be abbreviated to only showing the first line in the table view. In that case, the abbreviated lines will be indicated with '[...]'.
To view the full output, use the '--json' flag.`,
Examples: []ExampleDoc{
{
Command: "sdpctl sites list",
Expand Down

0 comments on commit c41e0a4

Please sign in to comment.