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

[Docs-only] add version command to docs #770

Merged
merged 1 commit into from
Oct 30, 2020
Merged

Conversation

C0rby
Copy link
Contributor

@C0rby C0rby commented Oct 28, 2020

We could consider just pasting the usage printed by the commands to the docs since they are 'documentation' and are easier to update.

For example here the usage from the accounts service:

NAME:
   ocis accounts - Start accounts server

USAGE:
   ocis accounts command [command options] [arguments...]

COMMANDS:
   list, ls        List existing accounts
   add, create, a  Create a new account
   update          Make changes to an existing account
   remove, rm      Removes an existing account
   inspect         Show detailed data on an existing account
   version         Print the versions of the running instances
   help, h         Shows a list of commands or help for one command

OPTIONS:
   --http-namespace value             Set the base namespace for the http namespace (default: "com.owncloud.web") [$ACCOUNTS_HTTP_NAMESPACE]
   --http-addr value                  Address to bind http server (default: "0.0.0.0:9181") [$ACCOUNTS_HTTP_ADDR]
   --http-root value                  Root path of http server (default: "/") [$ACCOUNTS_HTTP_ROOT]
   --grpc-namespace value             Set the base namespace for the grpc namespace (default: "com.owncloud.api") [$ACCOUNTS_GRPC_NAMESPACE]
   --grpc-addr value                  Address to bind grpc server (default: "0.0.0.0:9180") [$ACCOUNTS_GRPC_ADDR]
   --name value                       service name (default: "accounts") [$ACCOUNTS_NAME]
   --accounts-data-path value         accounts folder (default: "/var/tmp/ocis-accounts") [$ACCOUNTS_DATA_PATH]
   --asset-path value                 Path to custom assets [$ACCOUNTS_ASSET_PATH]
   --jwt-secret value                 Used to create JWT to talk to reva, should equal reva's jwt-secret (default: "Pive-Fumkiu4") [$ACCOUNTS_JWT_SECRET]
   --storage-disk-path value          Path on the local disk, e.g. /var/tmp/ocis-accounts [$ACCOUNTS_STORAGE_DISK_PATH]
   --storage-cs3-provider-addr value  bind address for the metadata storage provider (default: "localhost:9215") [$ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR]
   --storage-cs3-data-url value       http endpoint of the metadata storage (default: "http://localhost:9216") [$ACCOUNTS_STORAGE_CS3_DATA_URL]
   --storage-cs3-data-prefix value    path prefix for the http endpoint of the metadata storage, without leading slash (default: "data") [$ACCOUNTS_STORAGE_CS3_DATA_PREFIX]
   --storage-cs3-jwt-secret value     Used to create JWT to talk to reva, should equal reva's jwt-secret (default: "Pive-Fumkiu4") [$ACCOUNTS_STORAGE_CS3_JWT_SECRET]
   --service-user-uuid value          uuid of the internal service user (required on EOS) (default: "95cb8724-03b2-11eb-a0a6-c33ef8ef53ad") [$ACCOUNTS_SERVICE_USER_UUID]
   --service-user-username value      username of the internal service user (required on EOS) [$ACCOUNTS_SERVICE_USER_USERNAME]
   --service-user-uid value           uid of the internal service user (required on EOS) (default: 0) [$ACCOUNTS_SERVICE_USER_UID]
   --service-user-gid value           gid of the internal service user (required on EOS) (default: 0) [$ACCOUNTS_SERVICE_USER_GID]
   --uid-index-lower-bound value      define a starting point for the account UID (default: 0) [$ACCOUNTS_UID_INDEX_LOWER_BOUND]
   --gid-index-lower-bound value      define a starting point for the account GID (default: 1000) [$ACCOUNTS_GID_INDEX_LOWER_BOUND]
   --uid-index-upper-bound value      define an ending point for the account UID (default: 0) [$ACCOUNTS_UID_INDEX_UPPER_BOUND]
   --gid-index-upper-bound value      define an ending point for the account GID (default: 1000) [$ACCOUNTS_GID_INDEX_UPPER_BOUND]
   --help                             Show the help (default: false)
   --version                          Print the version (default: false)

@C0rby C0rby requested a review from micbar October 28, 2020 16:46
@update-docs
Copy link

update-docs bot commented Oct 28, 2020

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@micbar micbar merged commit 72491b4 into master Oct 30, 2020
@delete-merged-branch delete-merged-branch bot deleted the document-version-cmd branch October 30, 2020 08:47
ownclouders pushed a commit that referenced this pull request Oct 30, 2020
Merge: d34b5dc 788b18f
Author: Michael Barz <[email protected]>
Date:   Fri Oct 30 09:47:27 2020 +0100

    Merge pull request #770 from owncloud/document-version-cmd

    [Docs-only] add version command to docs
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.

2 participants