Skip to content

Commit

Permalink
Merge pull request #358 from UffizziCloud/feature/341_help-pages-for-dev
Browse files Browse the repository at this point in the history
[341] Help pages for uffizzi dev -h and uffizzi dev start -h
  • Loading branch information
moklidia authored Oct 19, 2023
2 parents 577d8e7 + 8d0f430 commit d5af6cd
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 1 deletion.
2 changes: 1 addition & 1 deletion man/uffizzi
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "UFFIZZI" "" "September 2023" ""
.TH "UFFIZZI" "" "October 2023" ""
.SH "NAME"
\fBuffizzi\fR \- manage Uffizzi resources
.SH "SYNOPSIS"
Expand Down
51 changes: 51 additions & 0 deletions man/uffizzi-dev
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

43 changes: 43 additions & 0 deletions man/uffizzi-dev.ronn
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.

0 comments on commit d5af6cd

Please sign in to comment.