d-bis/ProxmoxVE
4
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

Update documentation links and improve clarity across various files

Browse Source
This commit is contained in:
defiQUG
2026-03-02 12:05:31 -08:00
parent c1445f30bf
commit 9e20d471af
15 changed files with 58 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@@ -295,4 +295,4 @@ Found an error? Want to improve docs?
---
**Welcome to ProxmoxVE! Start with [CONTRIBUTION_GUIDE.md](CONTRIBUTION_GUIDE.md) or choose your role above.** 🚀
**Welcome to ProxmoxVE! Start with [contribution/README.md](contribution/README.md) or choose your role above.** 🚀

18
docs/contribution/FORK_SETUP.md
View File

@@ -53,7 +53,7 @@ Updates links to `github.com/john/my-fork`
## What Gets Updated?
The script updates these documentation files:
- `docs/CONTRIBUTION_GUIDE.md` (4 links)
- `README.md` (4 links)
- `docs/README.md` (1 link)
- `docs/INDEX.md` (3 links)
- `docs/EXIT_CODES.md` (2 links)
@@ -88,7 +88,7 @@ The script updates these documentation files:
4. **Follow the guide**
```bash
cat docs/CONTRIBUTION_GUIDE.md
cat README.md
```
---
@@ -164,12 +164,12 @@ git checkout docs/*.backup
## Next Steps
1. ✅ Run `bash setup-fork.sh`
2. 📖 Read [docs/CONTRIBUTION_GUIDE.md](docs/CONTRIBUTION_GUIDE.md)
2. 📖 Read [README.md](README.md)
3. 🍴 Choose your contribution path:
- **Containers** → [docs/ct/README.md](docs/ct/README.md)
- **Installation** → [docs/install/README.md](docs/install/README.md)
- **VMs** → [docs/vm/README.md](docs/vm/README.md)
- **Tools** → [docs/tools/README.md](docs/tools/README.md)
- **Containers** → [docs/ct/README.md](../ct/README.md)
- **Installation** → [docs/install/README.md](../install/README.md)
- **VMs** → [docs/vm/README.md](../vm/README.md)
- **Tools** → [docs/tools/README.md](../tools/README.md)
4. 💻 Create your feature branch and contribute!
---
@@ -177,9 +177,9 @@ git checkout docs/*.backup
## Questions?
- **Fork Setup Issues?** → See [Troubleshooting](#troubleshooting) above
- **How to Contribute?** → [docs/CONTRIBUTION_GUIDE.md](docs/CONTRIBUTION_GUIDE.md)
- **How to Contribute?** → [README.md](README.md)
- **Git Workflows?** → `cat .git-setup-info`
- **Project Structure?** → [docs/README.md](docs/README.md)
- **Project Structure?** → [docs/README.md](../README.md)
---

8
docs/contribution/README.md
View File

@@ -96,7 +96,7 @@ All scripts and configurations must follow our coding standards to ensure consis
### Available Guides
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Essential coding standards and best practices
- **[CODE_AUDIT.md](CODE_AUDIT.md)** - Code review checklist and audit procedures
- **[CODE-AUDIT.md](CODE-AUDIT.md)** - Code review checklist and audit procedures
- **Container Scripts** - `/ct/` templates and guidelines
- **Install Scripts** - `/install/` templates and guidelines
- **JSON Configurations** - `/json/` structure and format
@@ -118,7 +118,7 @@ All scripts and configurations must follow our coding standards to ensure consis
Before submitting a pull request, ensure your code passes our audit:
**See**: [CODE_AUDIT.md](CODE_AUDIT.md) for complete audit checklist
**See**: [CODE-AUDIT.md](CODE-AUDIT.md) for complete audit checklist
Key points:
- Code consistency with existing scripts
@@ -301,13 +301,13 @@ bash docs/contribution/setup-fork.sh
### For Experienced Developers
1. Review [CONTRIBUTING.md](CONTRIBUTING.md) - Coding standards
2. Review [CODE_AUDIT.md](CODE_AUDIT.md) - Audit checklist
2. Review [CODE-AUDIT.md](CODE-AUDIT.md) - Audit checklist
3. Check templates in `/ct/` and `/install/`
4. Submit PR with confidence
### For Reviewers/Maintainers
1. Use [CODE_AUDIT.md](CODE_AUDIT.md) as review guide
1. Use [CODE-AUDIT.md](CODE-AUDIT.md) as review guide
2. Reference [docs/TECHNICAL_REFERENCE.md](../TECHNICAL_REFERENCE.md) for architecture
3. Check [docs/EXIT_CODES.md](../EXIT_CODES.md) for error handling

6
docs/ct/README.md
View File

@@ -45,7 +45,7 @@ See `/ct` directory for all container creation scripts. Common examples:
To understand how to create a container script:
1. Read: [UPDATED_APP-ct.md](../UPDATED_APP-ct.md)
1. Read: [UPDATED_APP-ct.md](DETAILED_GUIDE.md)
2. Study: A similar existing script in `/ct`
3. Copy template and customize
4. Test locally
@@ -55,13 +55,13 @@ To understand how to create a container script:
1. Create `ct/myapp.sh`
2. Create `install/myapp-install.sh`
3. Follow template in [UPDATED_APP-ct.md](../UPDATED_APP-ct.md)
3. Follow template in [UPDATED_APP-ct.md](DETAILED_GUIDE.md)
4. Test thoroughly
5. Submit PR with both files
## Common Tasks
- **Add new container application** → [CONTRIBUTION_GUIDE.md](../CONTRIBUTION_GUIDE.md)
- **Add new container application** → [contribution/README.md](../contribution/README.md)
- **Debug container creation** → [EXIT_CODES.md](../EXIT_CODES.md)
- **Understand build.func** → [misc/build.func/](../misc/build.func/)
- **Development mode debugging** → [DEV_MODE.md](../DEV_MODE.md)

6
docs/guides/CONFIGURATION_REFERENCE.md
View File

@@ -834,7 +834,7 @@ var_template_storage=nfs-templates
## See Also
- [Defaults System Guide](DEFAULTS_GUIDE.md)
- [Defaults System Guide](DEFAULTS_SYSTEM_GUIDE.md)
- [Unattended Deployments](UNATTENDED_DEPLOYMENTS.md)
- [Security Best Practices](SECURITY_GUIDE.md)
- [Network Configuration](NETWORK_GUIDE.md)
- [Security Best Practices](DEFAULTS_SYSTEM_GUIDE.md)
- [Network Configuration](DEFAULTS_SYSTEM_GUIDE.md)

6
docs/guides/UNATTENDED_DEPLOYMENTS.md
View File

@@ -982,7 +982,7 @@ main "$@"
## See Also
- [Defaults System Guide](DEFAULTS_GUIDE.md)
- [Defaults System Guide](DEFAULTS_SYSTEM_GUIDE.md)
- [Configuration Reference](CONFIGURATION_REFERENCE.md)
- [Security Best Practices](SECURITY_GUIDE.md)
- [Network Configuration](NETWORK_GUIDE.md)
- [Security Best Practices](DEFAULTS_SYSTEM_GUIDE.md)
- [Network Configuration](DEFAULTS_SYSTEM_GUIDE.md)

6
docs/install/README.md
View File

@@ -58,7 +58,7 @@ See `/install` directory for all installation scripts. Examples:
To understand how to create an installation script:
1. Read: [UPDATED_APP-install.md](../UPDATED_APP-install.md)
1. Read: [UPDATED_APP-install.md](DETAILED_GUIDE.md)
2. Study: A similar existing script in `/install`
3. Copy template and customize
4. Test in container
@@ -136,13 +136,13 @@ cleanup_lxc
1. Create `ct/myapp.sh` (host script)
2. Create `install/myapp-install.sh` (container script)
3. Follow 10-phase pattern in [UPDATED_APP-install.md](../UPDATED_APP-install.md)
3. Follow 10-phase pattern in [UPDATED_APP-install.md](DETAILED_GUIDE.md)
4. Test in actual container
5. Submit PR with both files
## Common Tasks
- **Create new installation script** → [UPDATED_APP-install.md](../UPDATED_APP-install.md)
- **Create new installation script** → [UPDATED_APP-install.md](DETAILED_GUIDE.md)
- **Install Node.js/PHP/Database** → [misc/tools.func/](../misc/tools.func/)
- **Setup Alpine container** → [misc/alpine-install.func/](../misc/alpine-install.func/)
- **Debug installation errors** → [EXIT_CODES.md](../EXIT_CODES.md)

10
docs/misc/README.md
View File

@@ -225,14 +225,14 @@ Start with: **[error_handler.func/](./error_handler.func/)** → **[EXIT_CODES.m
## 📚 **Related Top-Level Documentation**
- **[CONTRIBUTION_GUIDE.md](../CONTRIBUTION_GUIDE.md)** - How to contribute to ProxmoxVE
- **[UPDATED_APP-ct.md](../UPDATED_APP-ct.md)** - Container script guide
- **[UPDATED_APP-install.md](../UPDATED_APP-install.md)** - Installation script guide
- **[DEFAULTS_SYSTEM_GUIDE.md](../DEFAULTS_SYSTEM_GUIDE.md)** - Configuration system
- **[contribution/README.md](../contribution/README.md)** - How to contribute to ProxmoxVE
- **[UPDATED_APP-ct.md](../ct/DETAILED_GUIDE.md)** - Container script guide
- **[UPDATED_APP-install.md](../install/DETAILED_GUIDE.md)** - Installation script guide
- **[DEFAULTS_SYSTEM_GUIDE.md](../guides/DEFAULTS_SYSTEM_GUIDE.md)** - Configuration system
- **[TECHNICAL_REFERENCE.md](../TECHNICAL_REFERENCE.md)** - Architecture reference
- **[EXIT_CODES.md](../EXIT_CODES.md)** - Complete exit code reference
- **[DEV_MODE.md](../DEV_MODE.md)** - Development debugging modes
- **[CHANGELOG_MISC.md](../CHANGELOG_MISC.md)** - Change history
- **[CHANGELOG_MISC.md](../README.md)** - Change history
---

2
docs/misc/alpine-install.func/README.md
View File

@@ -255,7 +255,7 @@ netplan apply → Configure directly in interfaces
- **[install.func/](../install.func/)** - Standard installation functions
- **[core.func/](../core.func/)** - Utility functions
- **[error_handler.func/](../error_handler.func/)** - Error handling
- **[UPDATED_APP-install.md](../../UPDATED_APP-install.md)** - Application script guide
- **[UPDATED_APP-install.md](../../install/DETAILED_GUIDE.md)** - Application script guide
## Recent Updates

2
docs/misc/alpine-tools.func/README.md
View File

@@ -279,7 +279,7 @@ nginx -t
- **[tools.func/](../tools.func/)** - Debian/standard tool installation
- **[core.func/](../core.func/)** - Utility functions
- **[error_handler.func/](../error_handler.func/)** - Error handling
- **[UPDATED_APP-install.md](../../UPDATED_APP-install.md)** - Application script guide
- **[UPDATED_APP-install.md](../../install/DETAILED_GUIDE.md)** - Application script guide
## Recent Updates

2
docs/misc/cloud-init.func/README.md
View File

@@ -320,7 +320,7 @@ apt-get update && apt-get install -y package-name
- **[install.func/](../install.func/)** - Container installation (similar workflow)
- **[core.func/](../core.func/)** - Utility functions
- **[error_handler.func/](../error_handler.func/)** - Error handling
- **[UPDATED_APP-install.md](../../UPDATED_APP-install.md)** - Application setup guide
- **[UPDATED_APP-install.md](../../install/DETAILED_GUIDE.md)** - Application setup guide
- **Proxmox Docs**: https://pve.proxmox.com/wiki/Cloud-Init
## Recent Updates

2
docs/misc/install.func/README.md
View File

@@ -230,7 +230,7 @@ update_os
- **[core.func/](../core.func/)** - Utility functions and messaging
- **[error_handler.func/](../error_handler.func/)** - Error handling
- **[alpine-install.func/](../alpine-install.func/)** - Alpine-specific setup
- **[UPDATED_APP-install.md](../../UPDATED_APP-install.md)** - Application script guide
- **[UPDATED_APP-install.md](../../install/DETAILED_GUIDE.md)** - Application script guide
## Recent Updates

4
docs/misc/tools.func/README.md
View File

@@ -44,7 +44,7 @@ Practical examples showing how to use tool installation functions and common pat
### 🔗 [TOOLS_FUNC_INTEGRATION.md](./TOOLS_FUNC_INTEGRATION.md)
How tools.func integrates with other components and provides package/tool services.
### 🔧 [TOOLS_FUNC_ENVIRONMENT_VARIABLES.md](./TOOLS_FUNC_ENVIRONMENT_VARIABLES.md)
### 🔧 [TOOLS_FUNC_FUNCTIONS_REFERENCE.md](./TOOLS_FUNC_FUNCTIONS_REFERENCE.md)
Complete reference of environment variables and configuration options.
## Key Features
@@ -225,7 +225,7 @@ When adding new tool installation functions:
- **[core.func/](../core.func/)** - Utility functions and messaging
- **[install.func/](../install.func/)** - Installation workflow management
- **[error_handler.func/](../error_handler.func/)** - Error handling and recovery
- **[UPDATED_APP-install.md](../../UPDATED_APP-install.md)** - Application script guide
- **[UPDATED_APP-install.md](../../install/DETAILED_GUIDE.md)** - Application script guide
---

2
docs/vm/README.md
View File

@@ -13,7 +13,7 @@ VM documentation parallels container documentation but focuses on VM-specific fe
## Key Resources
- **[misc/cloud-init.func/](../misc/cloud-init.func/)** - Cloud-init provisioning documentation
- **[CONTRIBUTION_GUIDE.md](../CONTRIBUTION_GUIDE.md)** - Contribution workflow
- **[contribution/README.md](../contribution/README.md)** - Contribution workflow
- **[EXIT_CODES.md](../EXIT_CODES.md)** - Exit code reference
## VM Creation Flow

40
frontend/package.json generated
View File

@@ -30,54 +30,54 @@
"@radix-ui/react-switch": "^1.2.6",
"@radix-ui/react-tabs": "^1.1.13",
"@radix-ui/react-tooltip": "^1.2.8",
"@tanstack/react-query": "^5.90.12",
"@tanstack/react-query": "^5.90.21",
"chart.js": "^4.5.1",
"chartjs-plugin-datalabels": "^2.2.0",
"class-variance-authority": "^0.7.1",
"clsx": "^2.1.1",
"cmdk": "^1.1.1",
"date-fns": "^4.1.0",
"framer-motion": "^12.23.26",
"framer-motion": "^12.34.0",
"fuse.js": "^7.1.0",
"lucide-react": "^0.561.0",
"mini-svg-data-uri": "^1.4.4",
"motion": "^12.23.26",
"motion": "^12.34.0",
"next": "15.5.8",
"next-themes": "^0.4.6",
"nuqs": "^2.8.5",
"nuqs": "^2.8.8",
"react": "19.2.3",
"react-chartjs-2": "^5.3.1",
"react-code-blocks": "^0.1.6",
"react-datepicker": "^9.0.0",
"react-day-picker": "^9.12.0",
"react-datepicker": "^9.1.0",
"react-day-picker": "^9.13.2",
"react-dom": "19.2.3",
"react-icons": "^5.5.0",
"react-use-measure": "^2.1.7",
"recharts": "3.6.0",
"sharp": "^0.34.5",
"sonner": "^2.0.7",
"tailwind-merge": "^3.4.0",
"zod": "^4.2.1"
"tailwind-merge": "^3.4.1",
"zod": "^4.3.6"
},
"devDependencies": {
"@antfu/eslint-config": "^6.7.1",
"@eslint-react/eslint-plugin": "^2.3.13",
"@next/eslint-plugin-next": "^15.5.8",
"@tanstack/eslint-plugin-query": "^5.91.2",
"@types/node": "^25.0.2",
"@antfu/eslint-config": "^6.7.3",
"@eslint-react/eslint-plugin": "^2.13.0",
"@next/eslint-plugin-next": "^15.5.12",
"@tanstack/eslint-plugin-query": "^5.91.4",
"@types/node": "^25.2.3",
"@types/react": "npm:types-react@19.0.0-rc.1",
"@types/react-dom": "npm:types-react-dom@19.0.0-rc.1",
"@typescript-eslint/eslint-plugin": "^8.50.0",
"@typescript-eslint/parser": "^8.50.0",
"@vitejs/plugin-react": "^5.1.2",
"@typescript-eslint/eslint-plugin": "^8.55.0",
"@typescript-eslint/parser": "^8.55.0",
"@vitejs/plugin-react": "^5.1.4",
"eslint": "^9.39.2",
"eslint-config-next": "15.5.8",
"eslint-plugin-format": "^1.1.0",
"eslint-plugin-format": "^1.4.0",
"eslint-plugin-react-hooks": "^7.0.1",
"eslint-plugin-react-refresh": "^0.4.25",
"jsdom": "^27.3.0",
"eslint-plugin-react-refresh": "^0.4.26",
"jsdom": "^27.4.0",
"postcss": "^8.5.6",
"tailwindcss": "^3.4.17",
"tailwindcss": "^3.4.19",
"tailwindcss-animate": "^1.0.7",
"tailwindcss-animated": "^1.1.2",
"typescript": "^5.9.3"