T-Gander/ProxmoxVEDHelperScripts
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

setup fork

Browse Source
This commit is contained in:
montagneid
2026-05-08 13:38:08 +02:00
parent a6c664bea0
commit 97125647d9
225 changed files with 1634 additions and 366 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contribution/CONTRIBUTING.md
View File

@@ -36,8 +36,8 @@ Before contributing, set up:
Use these templates as your starting point:
- [CT template: `AppName.sh`](https://github.com/--full/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh)
- [Install template: `AppName-install.sh`](https://github.com/--full/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh)
- [CT template: `AppName.sh`](https://github.com/montagneid/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh)
- [Install template: `AppName-install.sh`](https://github.com/montagneid/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh)
## Script types
@@ -45,7 +45,7 @@ Use these templates as your starting point:
Reference guide:
- [CT coding guide for `AppName.sh`](https://github.com/--full/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md)
- [CT coding guide for `AppName.sh`](https://github.com/montagneid/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.md)
This script is responsible for:
@@ -57,7 +57,7 @@ This script is responsible for:
Reference guide:
- [Install coding guide for `AppName-install.sh`](https://github.com/--full/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md)
- [Install coding guide for `AppName-install.sh`](https://github.com/montagneid/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.md)
This script is responsible for:
@@ -131,7 +131,7 @@ Add a Json file with all Metadata for the App. [DOCS](https://community-scripts.
## Pages
- [CT Template: AppName.sh](https://github.com/--full/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh)
- [Install Template: AppName-install.sh](https://github.com/--full/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh)
- [CT Template: AppName.sh](https://github.com/montagneid/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/ct/AppName.sh)
- [Install Template: AppName-install.sh](https://github.com/montagneid/ProxmoxVED/blob/main/.github/CONTRIBUTOR_AND_GUIDES/install/AppName-install.sh)
- [Fork setup guide](./FORK_SETUP.md)
- [Contribution README](./README.md)

2
docs/contribution/FORK_SETUP.md
View File

@@ -98,7 +98,7 @@ The script updates these documentation files:
### Keep Your Fork Updated
```bash
# Add upstream if you haven't already
git remote add upstream https://github.com/--full/ProxmoxVED.git
git remote add upstream https://github.com/montagneid/ProxmoxVED.git
# Get latest from upstream
git fetch upstream

14
docs/contribution/GUIDE.md
View File

@@ -30,7 +30,7 @@
```bash
# 1. Fork the repository on GitHub
# Visit: https://github.com/--full/ProxmoxVED
# Visit: https://github.com/montagneid/ProxmoxVED
# Click: Fork (top right)
# 2. Clone your fork
@@ -174,7 +174,7 @@ Examples:
```bash
# 1. Fork on GitHub (one-time)
# Visit: https://github.com/--full/ProxmoxVED
# Visit: https://github.com/montagneid/ProxmoxVED
# Click: Fork
# 2. Clone your fork
@@ -182,7 +182,7 @@ git clone https://github.com/YOUR_USERNAME/ProxmoxVED.git
cd ProxmoxVED
# 3. Add upstream remote for updates
git remote add upstream https://github.com/--full/ProxmoxVED.git
git remote add upstream https://github.com/montagneid/ProxmoxVED.git
# 4. Create feature branch
git checkout -b feat/add-myapp
@@ -561,7 +561,7 @@ fi
# Copyright (c) 2021-2026 community-scripts ORG
# Author: YourUsername
# Co-Author: AnotherAuthor (for collaborative work)
# License: MIT | https://github.com/--full/ProxmoxVED/raw/main/LICENSE
# License: MIT | https://github.com/montagneid/ProxmoxVED/raw/main/LICENSE
# Source: https://github.com/app/repo
# Description: Brief description of what this script does
```
@@ -762,7 +762,7 @@ git push origin feat/add-myapp --force-with-lease
### Step 3: Create Pull Request on GitHub
**Visit**: https://github.com/--full/ProxmoxVED/pulls
**Visit**: https://github.com/montagneid/ProxmoxVED/pulls
**Click**: "New Pull Request"
@@ -982,8 +982,8 @@ echo "Edit /opt/myapp/config.json to customize settings"
- **Documentation**: `/docs` directory and wikis
- **Function Reference**: `/misc/*.md` wiki files
- **Examples**: Look at similar applications in `/ct` and `/install`
- **GitHub Issues**: https://github.com/--full/ProxmoxVED/issues
- **Discussions**: https://github.com/--full/ProxmoxVED/discussions
- **GitHub Issues**: https://github.com/montagneid/ProxmoxVED/issues
- **Discussions**: https://github.com/montagneid/ProxmoxVED/discussions
### Ask Questions

10
docs/contribution/README.md
View File

@@ -21,7 +21,7 @@ Complete guide to contributing to the ProxmoxVED project - from your first fork
```bash
# 1. Fork on GitHub
# Visit: https://github.com/--full/ProxmoxVED → Fork (top right)
# Visit: https://github.com/montagneid/ProxmoxVED → Fork (top right)
# 2. Clone your fork
git clone https://github.com/YOUR_USERNAME/ProxmoxVED.git
@@ -81,7 +81,7 @@ git config user.name "Your Name"
git config user.email "your.email@example.com"
# Add upstream remote for syncing
git remote add upstream https://github.com/--full/ProxmoxVED.git
git remote add upstream https://github.com/montagneid/ProxmoxVED.git
# Verify remotes
git remote -v
@@ -329,9 +329,9 @@ bash docs/contribution/setup-fork.sh
## 📞 Contact & Support
- **GitHub**: https://github.com/--full/ProxmoxVED
- **Issues**: https://github.com/--full/ProxmoxVED/issues
- **Discussions**: https://github.com/--full/ProxmoxVED/discussions
- **GitHub**: https://github.com/montagneid/ProxmoxVED
- **Issues**: https://github.com/montagneid/ProxmoxVED/issues
- **Discussions**: https://github.com/montagneid/ProxmoxVED/discussions
- **Discord**: [Join Server](https://discord.gg/UHrpNWGwkH)
---

2
docs/contribution/USER_SUBMITTED_GUIDES.md
View File

@@ -1,6 +1,6 @@
<div align="center">
<a href="#">
<img src="https://raw.githubusercontent.com/--full/ProxmoxVED/main/misc/images/logo.png" height="100px" />
<img src="https://raw.githubusercontent.com/montagneid/ProxmoxVED/main/misc/images/logo.png" height="100px" />
</a>
</div>
<h2 align="center">User Submitted Guides </h2>

8
docs/contribution/setup-fork.sh
View File

@@ -182,15 +182,15 @@ create_git_setup_info() {
git remote -v
# If you don't have 'upstream' configured, add it:
git remote add upstream https://github.com/--full/ProxmoxVED.git
git remote add upstream https://github.com/montagneid/ProxmoxVED.git
# Verify both remotes exist:
git remote -v
# Should show:
# origin https://github.com/YOUR_USERNAME/ProxmoxVED.git (fetch)
# origin https://github.com/YOUR_USERNAME/ProxmoxVED.git (push)
# upstream https://github.com/--full/ProxmoxVED.git (fetch)
# upstream https://github.com/--full/ProxmoxVED.git (push)
# upstream https://github.com/montagneid/ProxmoxVED.git (fetch)
# upstream https://github.com/montagneid/ProxmoxVED.git (push)
```
### Configure Git User (if not done globally)
@@ -316,7 +316,7 @@ echo ""
print_success "All documentation links updated to point to your fork"
print_info "Your fork: https://github.com/$USERNAME/$REPO_NAME"
print_info "Upstream: https://github.com/--full/ProxmoxVED"
print_info "Upstream: https://github.com/montagneid/ProxmoxVED"
echo ""
echo -e "${BLUE}Next Steps:${NC}"

4
docs/contribution/templates_ct/AppName.md
View File

@@ -52,7 +52,7 @@ source <(curl -s https://raw.githubusercontent.com/[USER]/[REPO]/refs/heads/[BRA
Final script:
```bash
source <(curl -s https://raw.githubusercontent.com/--full/ProxmoxVED/main/misc/build.func)
source <(curl -s https://raw.githubusercontent.com/montagneid/ProxmoxVED/main/misc/build.func)
```
> [!CAUTION]
@@ -67,7 +67,7 @@ Example:
```bash
# Copyright (c) 2021-2026 community-scripts ORG
# Author: [YourUserName]
# License: MIT | https://github.com/--full/ProxmoxVED/raw/main/LICENSE
# License: MIT | https://github.com/montagneid/ProxmoxVED/raw/main/LICENSE
# Source: [SOURCE_URL]
```

4
docs/contribution/templates_ct/AppName.sh
View File

@@ -1,8 +1,8 @@
#!/usr/bin/env bash
source <(curl -s https://raw.githubusercontent.com/--full/ProxmoxVED/main/misc/build.func)
source <(curl -s https://raw.githubusercontent.com/montagneid/ProxmoxVED/main/misc/build.func)
# Copyright (c) 2021-2026 community-scripts ORG
# Author: [YourUserName]
# License: MIT | https://github.com/--full/ProxmoxVED/raw/main/LICENSE
# License: MIT | https://github.com/montagneid/ProxmoxVED/raw/main/LICENSE
# Source: [SOURCE_URL]
# App Default Values

2
docs/contribution/templates_install/AppName-install.md
View File

@@ -59,7 +59,7 @@ Example:
```bash
# Copyright (c) 2021-2026 community-scripts ORG
# Author: [YourUserName]
# License: MIT | https://github.com/--full/ProxmoxVED/raw/main/LICENSE
# License: MIT | https://github.com/montagneid/ProxmoxVED/raw/main/LICENSE
# Source: [SOURCE_URL]
```

2
docs/contribution/templates_install/AppName-install.sh
View File

@@ -2,7 +2,7 @@
# Copyright (c) 2021-2026 community-scripts ORG
# Author: [YourUserName]
# License: MIT | https://github.com/--full/ProxmoxVED/raw/main/LICENSE
# License: MIT | https://github.com/montagneid/ProxmoxVED/raw/main/LICENSE
# Source: [SOURCE_URL]
# Import Functions und Setup