docs: improve usage sections

Signed-off-by: Sebastian Davids <[email protected]>
sdavids · Feb 3, 2025 · ef079ed · ef079ed
1 parent f593c8a
commit ef079ed
Show file tree

Hide file tree

Showing 42 changed files with 4 additions and 158 deletions.
diff --git a/docs/user-guide/modules/ROOT/pages/scripts/asciidoc/antora-build.adoc b/docs/user-guide/modules/ROOT/pages/scripts/asciidoc/antora-build.adoc
@@ -37,10 +37,7 @@ See: <<antora-build-example>>
 [,console]
 ----
 $ scripts/asciidoc/antora_build.sh
-----
 
-[,console]
-----
 $ tree --noreport -I .git /tmp/example
 /tmp/example
 └── docs

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/cert/copy-ca-based-cert.adoc b/docs/user-guide/modules/ROOT/pages/scripts/cert/copy-ca-based-cert.adoc
@@ -56,10 +56,6 @@ $ node --run cert:copy
 [,console]
 ----
 $ scripts/cert/copy_ca_based_cert.sh
-----
-
-[,console]
-----
 $ scripts/cert/copy_ca_based_cert.sh ~/.local/secrets/certs/localhost
 
 $ scripts/cert/copy_ca_based_cert.sh ~/.local/secrets/certs/https.internal https.internal

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/cert/copy-ca-root-cert.adoc b/docs/user-guide/modules/ROOT/pages/scripts/cert/copy-ca-root-cert.adoc
@@ -33,10 +33,7 @@ Related Script:       xref:scripts/git/git-cleanup.adoc#git-cleanup-untracked-ex
 [,console]
 ----
 $ scripts/cert/copy_ca_root_cert.sh
-----
 
-[,console]
-----
 $ scripts/cert/copy_ca_root_cert.sh ~/.local/secrets/certs/ca-root
 $ stat -f '%A %N' ~/.local/secrets/certs/ca-root/ca.crt
 600 /Users/example/.local/secrets/certs/ca-root/ca.crt

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/cert/delete-ca-based-cert.adoc b/docs/user-guide/modules/ROOT/pages/scripts/cert/delete-ca-based-cert.adoc
@@ -50,10 +50,6 @@ $ node --run cert:delete
 [,console]
 ----
 $ scripts/cert/delete_ca_based_cert.sh
-----
-
-[,console]
-----
 $ scripts/cert/delete_ca_based_cert.sh ~/.local/secrets/certs/localhost
 $ scripts/cert/delete_ca_based_cert.sh ~/.local/secrets/certs/https.internal https.internal
 ----

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/cert/delete-self-signed-cert.adoc b/docs/user-guide/modules/ROOT/pages/scripts/cert/delete-self-signed-cert.adoc
@@ -47,8 +47,10 @@ $ node --run cert:delete
 ----
 $ scripts/cert/delete_self_signed_cert.sh
 Removing 'localhost' certificate from keychain /Users/example/Library/Keychains/login.keychain-db ...
+
 $ scripts/cert/delete_self_signed_cert.sh ~/.local/secrets/certs/localhost
 Removing 'localhost' certificate from keychain /Users/example/Library/Keychains/login.keychain-db ...
+
 $ scripts/cert/delete_self_signed_cert.sh ~/.local/secrets/certs/https.internal https.internal
 Removing 'https.internal' certificate from keychain /Users/example/Library/Keychains/login.keychain-db ...
 ----

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/cert/renew-ca-based-cert.adoc b/docs/user-guide/modules/ROOT/pages/scripts/cert/renew-ca-based-cert.adoc
@@ -45,10 +45,6 @@ $ node --run cert:renew
 [,console]
 ----
 $ scripts/cert/renew_ca_based_cert.sh
-----
-
-[,console]
-----
 $ scripts/cert/renew_ca_based_cert.sh dist/etc/nginx
 
 $ scripts/cert/renew_ca_based_cert.sh . 30

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/cert/renew-self-signed-cert.adoc b/docs/user-guide/modules/ROOT/pages/scripts/cert/renew-self-signed-cert.adoc
@@ -51,10 +51,6 @@ $ node --run cert:renew
 [,console]
 ----
 $ scripts/cert/renew_self_signed_cert.sh
-----
-
-[,console]
-----
 $ scripts/cert/renew_self_signed_cert.sh dist/etc/nginx
 
 $ scripts/cert/renew_self_signed_cert.sh . 30

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/cert/verify-ca-based-cert.adoc b/docs/user-guide/modules/ROOT/pages/scripts/cert/verify-ca-based-cert.adoc
@@ -38,10 +38,6 @@ $ node --run cert:verify
 [,console]
 ----
 $ scripts/cert/verify_ca_based_cert.sh
-----
-
-[,console]
-----
 $ scripts/cert/verify_ca_based_cert.sh ~/.local/secrets/certs/localhost
 keychain: "/Library/Keychains/System.keychain"
 ...

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/cert/verify-self-signed-cert.adoc b/docs/user-guide/modules/ROOT/pages/scripts/cert/verify-self-signed-cert.adoc
@@ -33,10 +33,6 @@ $ node --run cert:verify
 [,console]
 ----
 $ scripts/cert/verify_self_signed_cert.sh
-----
-
-[,console]
-----
 $ scripts/cert/verify_self_signed_cert.sh ~/.local/secrets/certs/localhost
 keychain: "/Users/example/Library/Keychains/login.keychain-db"
 ...

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/docker/docker-build.adoc b/docs/user-guide/modules/ROOT/pages/scripts/docker/docker-build.adoc
@@ -30,10 +30,6 @@ See the general Docker script xref:scripts/docker/docker.adoc#usage[usage notes]
 [,console]
 ----
 $ scripts/docker/docker_build.sh
-----
-
-[,console]
-----
 $ scripts/docker/docker_build.sh -n
 
 $ scripts/docker/docker_build.sh -d scripts/docker/Dockerfile

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/docker/docker-ignore-all.adoc b/docs/user-guide/modules/ROOT/pages/scripts/docker/docker-ignore-all.adoc
@@ -24,10 +24,6 @@ It should be used as a starting point, i.e. you should remove entries which shou
 [,console]
 ----
 $ scripts/docker/docker_ignore_all.sh
-----
-
-[,console]
-----
 $ tree --noreport -a -I .git /tmp/example
 /tmp/example
 ├── .dockerignore
@@ -42,7 +38,6 @@ $ cat /tmp/example/.dockerignore
 .DS_Store
 [Dd]esktop.ini
 Thumbs.db
-
 .dockerignore
 Dockerfile
 ----
diff --git a/docs/user-guide/modules/ROOT/pages/scripts/general/copy-shell-scripts.adoc b/docs/user-guide/modules/ROOT/pages/scripts/general/copy-shell-scripts.adoc
@@ -58,11 +58,7 @@ export PATH="${HOME}/.local/scripts${PATH:+:${PATH}}"
 [,console]
 ----
 $ scripts/general/copy_shell_scripts.sh -d ~/.local/scripts
-----
 
-[,console]
-----
-$ scripts/general/copy_shell_scripts.sh -d ~/.local/scripts
 $ scripts/general/copy_shell_scripts.sh -d /tmp/dst -s /tmp/src
 The following script names are not unique:
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/general/fix-permissions.adoc b/docs/user-guide/modules/ROOT/pages/scripts/general/fix-permissions.adoc
@@ -39,10 +39,7 @@ If you use https://typicode.github.io/husky/[Husky] then the Husky base director
 [,console]
 ----
 $ scripts/general/fix_permissions.sh
-----
 
-[,console]
-----
 $ tree --noreport -p /tmp/example
 [drwxrwxrwx]  /tmp/example
 ├── [dr-xr-xr-x]  a

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/general/hash-filename.adoc b/docs/user-guide/modules/ROOT/pages/scripts/general/hash-filename.adoc
@@ -16,10 +16,6 @@ Use the optional second parameter `-e` to print the new filename to stdout.
 $ scripts/general/hash_filename.sh test.txt
 $ scripts/general/hash_filename.sh test-echo.txt -e
 test-echo.da39a3e.txt
-----
-
-[,console]
-----
 $ find . \( -type f -name '*.jpg' -o -name '*.png' \) \
 -exec scripts/general/hash_filename.sh {} \;
 ----
diff --git a/docs/user-guide/modules/ROOT/pages/scripts/general/shellscript-check.adoc b/docs/user-guide/modules/ROOT/pages/scripts/general/shellscript-check.adoc
@@ -21,10 +21,6 @@ If you use https://typicode.github.io/husky/[Husky]:
 [,console]
 ----
 $ scripts/general/shellscript_check.sh
-----
-
-[,console]
-----
 $ scripts/general/shellscript_check.sh /tmp
 ----
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/general/shellscript-format-check.adoc b/docs/user-guide/modules/ROOT/pages/scripts/general/shellscript-format-check.adoc
@@ -16,17 +16,16 @@ The following parameter is optional:
 [,console]
 ----
 $ scripts/general/shellscript_format_check.sh
-----
 
-[,console]
-----
 $ scripts/general/shellscript_format_check.sh /tmp/example
 $ echo $?
 1
+
 $ scripts/general/shellscript_format_check.sh -v /tmp/example
 /tmp/example/example.sh
 $ echo $?
 1
+
 $ scripts/general/shellscript_format.sh /tmp/example
 $ scripts/general/shellscript_format_check.sh /tmp/example
 $ echo $?

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/general/shellscript-format.adoc b/docs/user-guide/modules/ROOT/pages/scripts/general/shellscript-format.adoc
@@ -10,10 +10,6 @@
 [,console]
 ----
 $ scripts/general/shellscript_format.sh
-----
-
-[,console]
-----
 $ scripts/general/shellscript_format.sh /tmp/example
 ----
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/git/git-cleanup.adoc b/docs/user-guide/modules/ROOT/pages/scripts/git/git-cleanup.adoc
@@ -70,10 +70,6 @@ Copy this script into your project:
 [,console]
 ----
 $ scripts/git/git_cleanup.sh
-----
-
-[,console]
-----
 $ scripts/git/git_cleanup.sh -d /tmp/example
 $ scripts/git/git_cleanup.sh -n
 $ scripts/git/git_cleanup.sh -e now

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/git/git-delete-branches.adoc b/docs/user-guide/modules/ROOT/pages/scripts/git/git-delete-branches.adoc
@@ -22,10 +22,6 @@ All other local and remote branches will be irreversibly deleted--be careful, yo
 [,console]
 ----
 $ scripts/git/git_delete_branches.sh
-----
-
-[,console]
-----
 $ scripts/git/git_delete_branches.sh /tmp/example
 ----
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/git/git-delete-dsstore-files.adoc b/docs/user-guide/modules/ROOT/pages/scripts/git/git-delete-dsstore-files.adoc
@@ -17,10 +17,7 @@ You need to commit the changes afterward (if any `.DS_Store` files have previous
 [,console]
 ----
 $ scripts/git/git_delete_dsstore_files.sh
-----
 
-[,console]
-----
 $ tree --noreport -a -I .git /tmp/example
 /tmp/example
 ├── .DS_Store

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/git/git-ignore-all.adoc b/docs/user-guide/modules/ROOT/pages/scripts/git/git-ignore-all.adoc
@@ -30,10 +30,7 @@ link:https://gitignore.io[gitignore.io] can be used to add fine-grained ignores.
 [,console]
 ----
 $ scripts/git/git_ignore_all.sh
-----
 
-[,console]
-----
 $ tree --noreport -a -I .git /tmp/example1
 /tmp/example1
 $ scripts/git/git_ignore_all.sh /tmp/example1

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/git/git-is-working-tree-clean.adoc b/docs/user-guide/modules/ROOT/pages/scripts/git/git-is-working-tree-clean.adoc
@@ -10,10 +10,6 @@
 [,console]
 ----
 $ scripts/git/git_is_working_tree_clean.sh
-----
-
-[,console]
-----
 $ echo $?
 ----
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/git/git-set-identity.adoc b/docs/user-guide/modules/ROOT/pages/scripts/git/git-set-identity.adoc
@@ -46,10 +46,6 @@ See: <<example>>
 [,console]
 ----
 $ scripts/git/git_set_identity.sh
-----
-
-[,console]
-----
 $ scripts/git/git_set_identity.sh -e [email protected]
 $ scripts/git/git_set_identity.sh \
 -d ~/workspaces/mutiny \

diff --git a/...er-guide/modules/ROOT/pages/scripts/gradle/check-reproducible-build-gradle.adoc b/...er-guide/modules/ROOT/pages/scripts/gradle/check-reproducible-build-gradle.adoc
@@ -123,10 +123,6 @@ jobs:
 [,console]
 ----
 $ scripts/gradle/check_reproducible_build_gradle.sh
-----
-
-[,console]
-----
 $ scripts/gradle/check_reproducible_build_gradle.sh /tmp/example
 ----
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/java/java-format-check.adoc b/docs/user-guide/modules/ROOT/pages/scripts/java/java-format-check.adoc
@@ -75,10 +75,7 @@ If you are using a JetBrains IDE you might want to use the https://plugins.jetbr
 [,console]
 ----
 $ scripts/java/java_format_check.sh
-----
 
-[,console]
-----
 $ scripts/java/java_format_check.sh /tmp/example/src/main/java
 $ echo $?
 1

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/java/java-format.adoc b/docs/user-guide/modules/ROOT/pages/scripts/java/java-format.adoc
@@ -69,10 +69,6 @@ If you are using a JetBrains IDE you might want to use the https://plugins.jetbr
 [,console]
 ----
 $ scripts/java/java_format.sh
-----
-
-[,console]
-----
 $ scripts/java/java_format.sh /tmp/example/src/main/java
 ----
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/nodejs/clean-node.adoc b/docs/user-guide/modules/ROOT/pages/scripts/nodejs/clean-node.adoc
@@ -33,9 +33,5 @@ $ node --run clean:node && npm i
 [,console]
 ----
 $ scripts/nodejs/clean_node.sh
-----
-
-[,console]
-----
 $ scripts/nodejs/clean_node.sh /tmp/nodejs-example-project
 ----
diff --git a/docs/user-guide/modules/ROOT/pages/scripts/nodejs/dependency-check-node.adoc b/docs/user-guide/modules/ROOT/pages/scripts/nodejs/dependency-check-node.adoc
@@ -57,10 +57,6 @@ $ npm config ls -l
 [,console]
 ----
 $ scripts/dependency_check_node.sh
-----
-
-[,console]
-----
 $ scripts/dependency_check_node.sh /tmp/example
 $ scripts/dependency_check_node.sh /tmp/example false
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/nodejs/macos-node-modules-fix.adoc b/docs/user-guide/modules/ROOT/pages/scripts/nodejs/macos-node-modules-fix.adoc
@@ -69,10 +69,6 @@ $ npm install && node --run macos:fix-node-modules
 [,console]
 ----
 $ scripts/nodejs/macos_node_modules_fix.sh
-----
-
-[,console]
-----
 $ scripts/nodejs/macos_node_modules_fix.sh /tmp/example_project
 
 $ xattr -r /tmp/example_workspace

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/pdf/pdf-remove-metadata.adoc b/docs/user-guide/modules/ROOT/pages/scripts/pdf/pdf-remove-metadata.adoc
@@ -24,10 +24,6 @@ PDF Version                     : 1.4
 [,console]
 ----
 $ scripts/pdf/pdf_remove_metadata.sh test.pdf
-----
-
-[,console]
-----
 $ find dist -type f -name '*.pdf' -exec scripts/pdf/pdf_remove_metadata.sh {} \;
 ----
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/web/compress-brotli.adoc b/docs/user-guide/modules/ROOT/pages/scripts/web/compress-brotli.adoc
@@ -35,10 +35,6 @@ Here is a fragment to be placed into your `.htaccess` or https://httpd.apache.or
 [,console]
 ----
 $ scripts/web/compress_brotli.sh test.txt
-----
-
-[,console]
-----
 $ find dist \( -type f -name '*.html' -o -name '*.css' \) -exec scripts/web/compress_brotli.sh {} \;
 ----
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/web/compress-gzip.adoc b/docs/user-guide/modules/ROOT/pages/scripts/web/compress-gzip.adoc
@@ -35,10 +35,6 @@ Here is a fragment to be placed into your `.htaccess` or https://httpd.apache.or
 [,console]
 ----
 $ scripts/web/compress_gzip.sh test.txt
-----
-
-[,console]
-----
 $ find dist \( -type f -name '*.html' -o -name '*.css' \) -exec scripts/web/compress_gzip.sh {} \;
 ----
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/web/compress-zstd.adoc b/docs/user-guide/modules/ROOT/pages/scripts/web/compress-zstd.adoc
@@ -35,10 +35,6 @@ Here is a fragment to be placed into your `.htaccess` or https://httpd.apache.or
 [,console]
 ----
 $ scripts/web/compress_zstd.sh test.txt
-----
-
-[,console]
-----
 $ find dist \( -type f -name '*.html' -o -name '*.css' \) -exec scripts/web/compress_zstd.sh {} \;
 ----
 

diff --git a/docs/user-guide/modules/ROOT/pages/scripts/web/minify-css.adoc b/docs/user-guide/modules/ROOT/pages/scripts/web/minify-css.adoc
@@ -25,10 +25,6 @@ last 2 versions
 [,console]
 ----
 $ scripts/web/minify_css.sh
-----
-
-[,console]
-----
 $ scripts/web/minify_css.sh dist
 ----