Docs: expand developer/debugging and tools references

mirror of https://github.com/community-scripts/ProxmoxVE.git synced 2026-09-21 20:05:48 +02:00

Add extensive documentation and examples across contribution, guides, templates and tools references. Key changes:
- Introduce a Developer Mode & Debugging section (dev_mode flags: trace, keep, pause, breakpoint, logs, dryrun, motd) in CONTRIBUTING.md with usage example.
- Provide a standard update_script() pattern and BookStack example in GUIDE.md to clarify update flow (stop services, backup, deploy, restore, migrate, restart).
- Add new helper entries (BookLore, KaraKeep) and advanced repository helpers (setup_deb822_repo, prepare_repository_setup, cleanup_tool_keyrings) plus utilities (setup_meilisearch, verify_tool_version) in HELPER_FUNCTIONS.md.
- Update install template to suggest PNPM, Java 21 and Meilisearch; update example DB setup notes in AppName-install.sh.
- Add var_diagnostics option and switch var_fuse to boolean/toggle wording in CONFIGURATION_REFERENCE.md; clarify privacy and defaults.
- Adjust example container definitions in UNATTENDED_DEPLOYMENTS.md (container entries and resource values).
- Change storage and flag variables and examples in BUILD_FUNC_USAGE_EXAMPLES.md (ssd-storage, var_fuse/var_tun, etc.).
- Expand TOOLS_FUNC_FUNCTIONS_REFERENCE.md with many setup_* function signatures, environment vars, clarified fetch_and_deploy_gh_release modes/parameters, and additional tool docs (nodejs, php, mariadb_db, postgresql_db, java, uv, yq, meilisearch, composer, build tools).

These updates improve onboarding, debugging guidance, and operational clarity for contributors and maintainers.

This commit is contained in:

CanbiZ (MickLesk)

2026-02-05 15:16:35 +01:00

parent 30bc127011

commit 2c18646d82

8 changed files with 410 additions and 54 deletions

									
										docs/misc/build.func/BUILD_FUNC_USAGE_EXAMPLES.md
									
		+3
		-3
	
												View File
												
				@@ -60,10 +60,10 @@ export var_gateway="192.168.1.1"

				export var_ip="192.168.1.101"

				export var_vlan="100"

				export var_mtu="9000"

				export var_template_storage="nfs-storage"

				export var_template_storage="ssd-storage"

				export var_container_storage="ssd-storage"

				export ENABLE_FUSE="true"

				export ENABLE_TUN="true"

				export var_fuse="yes"

				export var_tun="yes"

				export SSH="true"

				# Execute build.func