From 7db01be0a705b3c451fbcc1e7a064ae65d64f919 Mon Sep 17 00:00:00 2001 From: CanbiZ <47820557+MickLesk@users.noreply.github.com> Date: Sun, 18 Jan 2026 18:05:06 +0100 Subject: [PATCH] Update GitHub repo placeholders in docs and templates Replaced 'YourUsername/YourRepo' with 'owner/repo' in documentation and template scripts for consistency and clarity. This change standardizes example usage and reduces confusion for contributors. --- docs/contribution/AI.md | 6 +++--- docs/contribution/README.md | 1 + docs/contribution/templates_ct/AppName.sh | 2 +- docs/contribution/templates_install/AppName-install.sh | 2 +- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/contribution/AI.md b/docs/contribution/AI.md index fe0b241b9..49a2dfe17 100644 --- a/docs/contribution/AI.md +++ b/docs/contribution/AI.md @@ -168,9 +168,9 @@ cleanup_lxc ### Release Management -| Function | Description | Example | -| ----------------------------- | ----------------------------------- | ------------------------------------------------------------- | -| `fetch_and_deploy_gh_release` | Fetches and installs GitHub Release | `fetch_and_deploy_gh_release "app" "YourUsername/YourRepo"` | +| Function | Description | Example | +| ----------------------------- | ----------------------------------- | --------------------------------------------------------- | +| `fetch_and_deploy_gh_release` | Fetches and installs GitHub Release | `fetch_and_deploy_gh_release "app" "owner/repo"` | | `check_for_gh_release` | Checks for new version | `if check_for_gh_release "app" "YourUsername/YourRepo"; then` | **Modes for `fetch_and_deploy_gh_release`:** diff --git a/docs/contribution/README.md b/docs/contribution/README.md index 639d9ed30..ec81db7a3 100644 --- a/docs/contribution/README.md +++ b/docs/contribution/README.md @@ -85,6 +85,7 @@ bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/Proxmo **During Development (you, in your fork):** ```bash +# You test locally with your cloned files bash ct/myapp.sh # The script's curl commands are updated by setup-fork.sh to pull from YOUR fork diff --git a/docs/contribution/templates_ct/AppName.sh b/docs/contribution/templates_ct/AppName.sh index 369eb424c..f8c685fd3 100644 --- a/docs/contribution/templates_ct/AppName.sh +++ b/docs/contribution/templates_ct/AppName.sh @@ -72,7 +72,7 @@ function update_script() { # Step 5: Download and deploy new version # CLEAN_INSTALL=1 removes old directory before extracting - CLEAN_INSTALL=1 fetch_and_deploy_gh_release "[appname]" "YourUsername/YourRepo" "tarball" "latest" "/opt/[appname]" + CLEAN_INSTALL=1 fetch_and_deploy_gh_release "[appname]" "owner/repo" "tarball" "latest" "/opt/[appname]" # Step 6: Run post-update commands (uncomment as needed) # These examples show common patterns - use what applies to your app: diff --git a/docs/contribution/templates_install/AppName-install.sh b/docs/contribution/templates_install/AppName-install.sh index 604e17ad7..f4863bcd6 100644 --- a/docs/contribution/templates_install/AppName-install.sh +++ b/docs/contribution/templates_install/AppName-install.sh @@ -55,7 +55,7 @@ msg_ok "Installed Dependencies" # fetch_and_deploy_gh_release "myapp" "YourUsername/myapp" "binary" "latest" "/tmp" # fetch_and_deploy_gh_release "myapp" "YourUsername/myapp" "prebuild" "latest" "/opt/myapp" "myapp-*.tar.gz" -fetch_and_deploy_gh_release "[appname]" "YourUsername/YourRepo" "tarball" "latest" "/opt/[appname]" +fetch_and_deploy_gh_release "[appname]" "owner/repo" "tarball" "latest" "/opt/[appname]" # ============================================================================= # CONFIGURE APPLICATION