KNEL/KNELProductionContainers
2
0
Fork 0
Code Pull Requests Actions Packages Releases Activity

feat(docs): add clickable file links in README.md

Browse Source 
- Updated all file references to be clickable links for better navigation
- Repository structure, workflow sections, and resource links now clickable
- Improves developer experience and documentation usability
- Maintains proper markdown syntax for GitHub/Gitea rendering

🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Charles N Wyble - admin
2025-09-04 08:52:17 -05:00
parent 659640836c
commit 4f71cba131
1 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@@ -6,25 +6,25 @@ This repository contains the infrastructure and tooling for packaging applicatio
``` ```
KNELProductionContainers/ KNELProductionContainers/
├── README.md # This file ├── [README.md](README.md) # This file
├── PLAN.md # Overall packaging strategy and roadmap ├── [PLAN.md](PLAN.md) # Overall packaging strategy and roadmap
├── TASKS.md # Application checklist and status ├── [TASKS.md](TASKS.md) # Application checklist and status
├── WORKLOG.md # Development progress log ├── [WORKLOG.md](WORKLOG.md) # Development progress log
├── .gitignore # Git exclusions for workspace ├── [.gitignore](.gitignore) # Git exclusions for workspace
│ │
├── CloudronPackages/ # ✅ Final tested packages (tracked in git) ├── [CloudronPackages/](CloudronPackages/) # ✅ Final tested packages (tracked in git)
│ ├── PackageTemplate/ # Template and LLM prompts │ ├── [PackageTemplate/](CloudronPackages/PackageTemplate/) # Template and LLM prompts
│ ├── EasyGate/ # Completed packages │ ├── [EasyGate/](CloudronPackages/EasyGate/) # Completed packages
│ └── [AppName]/ # Individual app packages │ └── [AppName]/ # Individual app packages
│ │
├── CloudronPackagingWorkspace/ # 🚧 Development workspace ├── [CloudronPackagingWorkspace/](CloudronPackagingWorkspace/) # 🚧 Development workspace
│ ├── Docker/ (gitignored) # ~100 cloned upstream repositories │ ├── Docker/ (gitignored) # ~100 cloned upstream repositories
│ ├── NonDocker/ (gitignored) # Non-Docker applications │ ├── NonDocker/ (gitignored) # Non-Docker applications
│ ├── UpstreamVendor-Clone.sh # Script to clone upstream sources │ ├── [UpstreamVendor-Clone.sh](CloudronPackagingWorkspace/UpstreamVendor-Clone.sh) # Script to clone upstream sources
│ └── UpstreamVendor-Update.sh # Script to update upstream sources │ └── [UpstreamVendor-Update.sh](CloudronPackagingWorkspace/UpstreamVendor-Update.sh) # Script to update upstream sources
│ │
├── KNEL-Cloudron/ # 🏢 KNEL-specific deployment configs ├── [KNEL-Cloudron/](KNEL-Cloudron/) # 🏢 KNEL-specific deployment configs
└── KNEL-NonCloudron/ # Non-Cloudron container configs └── [KNEL-NonCloudron/](KNEL-NonCloudron/) # Non-Cloudron container configs
``` ```
## 🚀 Quick Start ## 🚀 Quick Start
@@ -59,8 +59,8 @@ chmod +x CloudronPackagingWorkspace/*.sh
## 📋 Packaging Workflow ## 📋 Packaging Workflow
### 1. Choose Application ### 1. Choose Application
- Check `TASKS.md` for priority applications - Check [TASKS.md](TASKS.md) for priority applications
- Verify upstream source is available in `CloudronPackagingWorkspace/Docker/` - Verify upstream source is available in [CloudronPackagingWorkspace/Docker/](CloudronPackagingWorkspace/Docker/)
### 2. Create Feature Branch ### 2. Create Feature Branch
```bash ```bash
@@ -105,15 +105,15 @@ cloudron install --image registry/[appname]:version
mv /workspace/[appname]_package_new ./CloudronPackages/[AppName]/ mv /workspace/[appname]_package_new ./CloudronPackages/[AppName]/
# Update documentation # Update documentation
# - Add entry to TASKS.md # - Add entry to [TASKS.md](TASKS.md)
# - Update WORKLOG.md # - Update [WORKLOG.md](WORKLOG.md)
# - Document any special requirements # - Document any special requirements
``` ```
### 6. Create Pull Request ### 6. Create Pull Request
```bash ```bash
git add CloudronPackages/[AppName]/ git add CloudronPackages/[AppName]/
git add TASKS.md WORKLOG.md git add [TASKS.md](TASKS.md) [WORKLOG.md](WORKLOG.md)
git commit -m "Add [AppName] Cloudron package" git commit -m "Add [AppName] Cloudron package"
git push origin feature/package-[appname] git push origin feature/package-[appname]
# Create PR to integration branch # Create PR to integration branch
@@ -175,9 +175,9 @@ Each Cloudron package requires:
- **Usage**: Accelerate development with AI-assisted packaging - **Usage**: Accelerate development with AI-assisted packaging
### Helper Scripts ### Helper Scripts
- **`UpstreamVendor-Clone.sh`**: Clone all upstream repositories - **[UpstreamVendor-Clone.sh](CloudronPackagingWorkspace/UpstreamVendor-Clone.sh)**: Clone all upstream repositories
- **`UpstreamVendor-Update.sh`**: Update existing checkouts - **[UpstreamVendor-Update.sh](CloudronPackagingWorkspace/UpstreamVendor-Update.sh)**: Update existing checkouts
- **Template Prompt**: `CloudronPackages/PackageTemplate/CloudronPackagePrompt.md` - **Template Prompt**: [CloudronPackagePrompt.md](CloudronPackages/PackageTemplate/CloudronPackagePrompt.md)
### Cloudron Resources ### Cloudron Resources
- [Official Packaging Tutorial](https://docs.cloudron.io/packaging/tutorial/) - [Official Packaging Tutorial](https://docs.cloudron.io/packaging/tutorial/)
@@ -186,9 +186,9 @@ Each Cloudron package requires:
## 📊 Progress Tracking ## 📊 Progress Tracking
- **Overall Progress**: See `TASKS.md` - **Overall Progress**: See [TASKS.md](TASKS.md)
- **Daily Progress**: See `WORKLOG.md` - **Daily Progress**: See [WORKLOG.md](WORKLOG.md)
- **Strategy & Roadmap**: See `PLAN.md` - **Strategy & Roadmap**: See [PLAN.md](PLAN.md)
### Current Status ### Current Status
- ✅ Repository structure established - ✅ Repository structure established
@@ -200,8 +200,8 @@ Each Cloudron package requires:
## 🤝 Contributing ## 🤝 Contributing
### For KNEL Team Members ### For KNEL Team Members
1. Review `PLAN.md` for current priorities 1. Review [PLAN.md](PLAN.md) for current priorities
2. Check `TASKS.md` for available applications 2. Check [TASKS.md](TASKS.md) for available applications
3. Follow the packaging workflow above 3. Follow the packaging workflow above
4. Update documentation as you work 4. Update documentation as you work
5. Create feature branches for each application 5. Create feature branches for each application