Skip to content

Commit 04efce4

Browse files
eric-schneidermcpaddy
authored andcommitted
DOC-5647 Update couchbase-cli nav
This change seeks to update the nav for Couchbase Server to include the latest `couchbase-cli` commands. == Mod #1 The `couchbase-cli` commands that appear in the Couchbase Server left-hand navigation are determined by what's listed in docs/modules/cli/pages/_partials/cbcli/nav.adoc. Commands added to nav: * `couchbase-cli collection-manage` * `couchbase-cli enable-developer-preview` * `couchbase-cli ip-family` * `couchbase-cli master-password` * `couchbase-cli node-to-node-encryption` * `couchbase-cli setting-alternate-address` * `couchbase-cli setting-master-password` * `couchbase-cli setting-on-demand` * `couchbase-cli setting-query` * `couchbase-cli setting-rebalance` * `couchbase-cli setting-saslauthd` * `couchbase-cli user-change-password` == Mod #2 The commands pages themselves are located in /docs/modules/cli/pages/cbcli. Some of these are considered internal tools and are not meant to be listed in the nav (though, they are still published on the site and can be reached via URL if you know where to look). To avoid confusion about having a different number of pages vs. number of listings in the nav file, I've added listings in the nav for these items, but commented them out with an explanation. Commands added to nav but commented out: * `couchbase-cli help` * `couchbase-cli server-eshell` == Mod #3 At this time, it is understood that there was only one command that was removed in 6.5: `couchbase-cli admin-role-manage`. The deprecation notice indicated that the functionality of this command was inherited by `couchbase-cli user-manage`, so a page alias was added to that file to redirect the old page to the new one. Change-Id: I01ec4519b515f103fc1ac8001264fc428908dac0 Reviewed-on: http://review.couchbase.org/113214 Tested-by: Build Bot <[email protected]> Reviewed-by: Carlos Gonzalez <[email protected]>
1 parent 829fd2a commit 04efce4

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

docs/modules/cli/pages/_partials/cbcli/nav.adoc

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
* xref:cli:cbcli/couchbase-cli.adoc[couchbase-cli]
2-
** xref:cli:cbcli/couchbase-cli-admin-role-manage.adoc[admin-role-manage]
32
** xref:cli:cbcli/couchbase-cli-bucket-compact.adoc[bucket-compact]
43
** xref:cli:cbcli/couchbase-cli-bucket-create.adoc[bucket-create]
54
** xref:cli:cbcli/couchbase-cli-bucket-delete.adoc[bucket-delete]
@@ -11,33 +10,47 @@
1110
** xref:cli:cbcli/couchbase-cli-collect-logs-start.adoc[collect-logs-start]
1211
** xref:cli:cbcli/couchbase-cli-collect-logs-status.adoc[collect-logs-status]
1312
** xref:cli:cbcli/couchbase-cli-collect-logs-stop.adoc[collect-logs-stop]
13+
** xref:cli:cbcli/couchbase-cli-collection-manage.adoc[collection-manage]
14+
** xref:cli:cbcli/couchbase-cli-enable-developer-preview.adoc[enable-developer-preview]
1415
** xref:cli:cbcli/couchbase-cli-eventing-function-setup.adoc[eventing-function-setup]
1516
** xref:cli:cbcli/couchbase-cli-failover.adoc[failover]
1617
** xref:cli:cbcli/couchbase-cli-group-manage.adoc[group-manage]
18+
// ** xref:cli:cbcli/couchbase-cli-help.adoc[help] #tooling Patrick Varley (20Jun2019): "couchbase-cli-help.adoc does seem pointless and there is not a help command, so not sure why it's there"
1719
** xref:cli:cbcli/couchbase-cli-host-list.adoc[host-list]
20+
** xref:cli:cbcli/couchbase-cli-ip-family.adoc[ip-family]
21+
** xref:cli:cbcli/couchbase-cli-master-password.adoc[master-password]
1822
** xref:cli:cbcli/couchbase-cli-node-init.adoc[node-init]
23+
** xref:cli:cbcli/couchbase-cli-node-to-node-encryption.adoc[node-to-node-encryption]
1924
** xref:cli:cbcli/couchbase-cli-rebalance.adoc[rebalance]
2025
** xref:cli:cbcli/couchbase-cli-rebalance-status.adoc[rebalance-status]
2126
** xref:cli:cbcli/couchbase-cli-rebalance-stop.adoc[rebalance-stop]
2227
** xref:cli:cbcli/couchbase-cli-recovery.adoc[recovery]
2328
** xref:cli:cbcli/couchbase-cli-reset-admin-password.adoc[reset-admin-password]
2429
** xref:cli:cbcli/couchbase-cli-server-add.adoc[server-add]
30+
// ** xref:cli:cbcli/couchbase-cli-server-eshell.adoc[server-eshell] #tooling Patrick Varley (20Jun2019): "server-eshell is more of a internal tool. The usage on the command line does not print it, so we can leave it for now."
2531
** xref:cli:cbcli/couchbase-cli-server-info.adoc[server-info]
2632
** xref:cli:cbcli/couchbase-cli-server-list.adoc[server-list]
2733
** xref:cli:cbcli/couchbase-cli-server-readd.adoc[server-readd]
2834
** xref:cli:cbcli/couchbase-cli-setting-alert.adoc[setting-alert]
35+
** xref:cli:cbcli/couchbase-cli-setting-alternate-address.adoc[setting-alternate-address]
2936
** xref:cli:cbcli/couchbase-cli-setting-audit.adoc[setting-audit]
3037
** xref:cli:cbcli/couchbase-cli-setting-autofailover.adoc[setting-autofailover]
3138
** xref:cli:cbcli/couchbase-cli-setting-autoreprovision.adoc[setting-autoreprovision]
3239
** xref:cli:cbcli/couchbase-cli-setting-cluster.adoc[setting-cluster]
3340
** xref:cli:cbcli/couchbase-cli-setting-compaction.adoc[setting-compaction]
3441
** xref:cli:cbcli/couchbase-cli-setting-index.adoc[setting-index]
3542
** xref:cli:cbcli/couchbase-cli-setting-ldap.adoc[setting-ldap]
43+
** xref:cli:cbcli/couchbase-cli-setting-master-password.adoc[setting-master-password]
3644
** xref:cli:cbcli/couchbase-cli-setting-notification.adoc[setting-notification]
45+
** xref:cli:cbcli/couchbase-cli-setting-on-demand.adoc[setting-on-demand]
3746
** xref:cli:cbcli/couchbase-cli-setting-password-policy.adoc[setting-password-policy]
47+
** xref:cli:cbcli/couchbase-cli-setting-query.adoc[setting-query]
48+
** xref:cli:cbcli/couchbase-cli-setting-rebalance.adoc[setting-rebalance]
49+
** xref:cli:cbcli/couchbase-cli-setting-saslauthd.adoc[setting-saslauthd]
3850
** xref:cli:cbcli/couchbase-cli-setting-security.adoc[setting-security]
3951
** xref:cli:cbcli/couchbase-cli-setting-xdcr.adoc[setting-xdcr]
4052
** xref:cli:cbcli/couchbase-cli-ssl-manage.adoc[ssl-manage]
53+
** xref:cli:cbcli/couchbase-cli-user-change-password.adoc[user-change-password]
4154
** xref:cli:cbcli/couchbase-cli-user-manage.adoc[user-manage]
4255
** xref:cli:cbcli/couchbase-cli-xdcr-replicate.adoc[xdcr-replicate]
4356
** xref:cli:cbcli/couchbase-cli-xdcr-setup.adoc[xdcr-setup]

docs/modules/cli/pages/cbcli/couchbase-cli-user-manage.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= couchbase-cli-user-manage(1)
2+
:page-aliases: cli:cbcli/couchbase-cli-admin-role-manage
23
ifndef::doctype-manpage[:doctitle: user-manage]
34

45
ifdef::doctype-manpage[]

0 commit comments

Comments
 (0)