Skip to content

Commit

Permalink
minor modifications to help text string (#633)
Browse files Browse the repository at this point in the history
Signed-off-by: Ross Turk <[email protected]>
  • Loading branch information
rossturk authored and potiuk committed Jun 17, 2023
1 parent 6eee474 commit 422bd13
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions site.sh
Original file line number Diff line number Diff line change
Expand Up @@ -33,34 +33,34 @@ function usage {
cat << EOF
usage: ${0} <command> [<args>]
These are ${0} commands used in various situations:
build-site Prepare dist directory with landing pages and documentation.
preview-landing-pages Starts the web server with preview of the website.
build-landing-pages Builds a landing pages.
prepare-theme Prepares and copies files needed for the proper functioning of the sphinx theme.
shell Start shell.
build-image Build a Docker image with a environment.
These are the ${0} commands that can be used in various situations:
build-site Prepare dist/ directory with landing pages and docs.
preview-landing-pages Start the web server with preview of the landing pages.
build-landing-pages Build the landing pages.
prepare-theme Copy required CSS/JS files from landing pages into the docs theme.
shell Start a shell.
build-image Build a Docker image with an environment.
install-node-deps Download all the Node dependencies.
check-site-links Checks if the links are correct in the website.
check-site-links Check to make sure that links are correct in the website.
lint-css Lint CSS files.
lint-js Lint Javascript files.
cleanup Delete the virtual environment in Docker.
stop Stop the environment.
help Display usage.
Unrecognized commands are run as programs in the container.
Unrecognized commands are run as programs inside the container.
For example, if you want to display a list of files, you
can execute the following command:
$0 ls
The following command can also be performed from the Docker environment:
The following commands can also be performed from the Docker environment:
install-node-deps, preview, build-site, lint-css, lint-js.
The lint-css and lint-js accept paths in arguments. If no path is given, the script
will be executed for all supported files.
The lint-css and lint-js commands accept paths in arguments. If no path is given,
the script will be executed for all supported files.
EOF
}
Expand Down

0 comments on commit 422bd13

Please sign in to comment.