-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #358 from UffizziCloud/feature/341_help-pages-for-dev
[341] Help pages for uffizzi dev -h and uffizzi dev start -h
- Loading branch information
Showing
3 changed files
with
95 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
.\" generated with Ronn-NG/v0.9.1 | ||
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 | ||
.TH "UFFIZZI\-DEV" "" "October 2023" "" | ||
.SH "NAME" | ||
\fBuffizzi\-dev\fR \- manage dev environments | ||
.SH "SYNOPSIS" | ||
.nf | ||
uffizzi dev COMMAND | ||
.fi | ||
.SH "DESCRIPTION" | ||
.nf | ||
Manage Uffizzi development environments\. | ||
|
||
Use these commands for building, pushing, and deploying your | ||
project changes to a remote development cluster\. Cloud\-based | ||
dev environments offer many benefits compared to traditional | ||
local development, including: | ||
\- More similar to production deployments | ||
\- Access to more memory and CPU for resource\-intensive | ||
apps | ||
\- Scalability and flexibility for microservices apps | ||
\- Faster build times | ||
\- Avoid accumulation of build artifacts on local machine | ||
\- App components available at public URLs or IP addresses | ||
\- TLS certificates for HTTPS | ||
\- Better team collaboration via shareable links | ||
|
||
For more information on Uffizzi clusters, see: | ||
https://docs\.uffizzi\.com/references/cli/ | ||
.fi | ||
.SH "COMMANDS" | ||
.nf | ||
COMMAND is one of the following: | ||
|
||
start | ||
Start a dev environment | ||
|
||
stop | ||
Stop a dev environment | ||
|
||
describe | ||
Display details of a dev environment | ||
|
||
ingress | ||
Display ingress hosts | ||
.fi | ||
.SH "HELP" | ||
.nf | ||
Run \'uffizzi dev COMMAND \-\-help\' for more information on a command\. | ||
.fi | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
uffizzi-dev - manage dev environments | ||
================================================================ | ||
|
||
## SYNOPSIS | ||
uffizzi dev COMMAND | ||
|
||
## DESCRIPTION | ||
Manage Uffizzi development environments. | ||
|
||
Use these commands for building, pushing, and deploying your | ||
project changes to a remote development cluster. Cloud-based | ||
dev environments offer many benefits compared to traditional | ||
local development, including: | ||
- More similar to production deployments | ||
- Access to more memory and CPU for resource-intensive | ||
apps | ||
- Scalability and flexibility for microservices apps | ||
- Faster build times | ||
- Avoid accumulation of build artifacts on local machine | ||
- App components available at public URLs or IP addresses | ||
- TLS certificates for HTTPS | ||
- Better team collaboration via shareable links | ||
|
||
For more information on Uffizzi clusters, see: | ||
https://docs.uffizzi.com/references/cli/ | ||
|
||
## COMMANDS | ||
COMMAND is one of the following: | ||
|
||
start | ||
Start a dev environment | ||
|
||
stop | ||
Stop a dev environment | ||
|
||
describe | ||
Display details of a dev environment | ||
|
||
ingress | ||
Display ingress hosts | ||
|
||
## HELP | ||
Run 'uffizzi dev COMMAND --help' for more information on a command. |