feat(docs): standardize README.md files across all stacks
- Update top-level README.md with AI collaboration section and working agreement - Standardize all stack README.md files (CloudronStack, LifecycleStack, SupportStack, ToolboxStack) with consistent structure: - Add Working Agreement section with consistent items across all stacks - Add AI Agent section identifying the responsible bot for each stack - Add License section with reference to main LICENSE file - Add Quick Start section where missing - Create missing LifecycleStack/collab directory with .gitkeep file - Add top-level QWEN.md file for tracking Topside agent work - Add top-level commit-template.txt and configure git to use it - Ensure consistent formatting and content across all documentation - Fix CloudronStack README title to match project structure This commit ensures all README files follow the same structure and contain necessary information for coordination between different Qwen agents working on each stack.
This commit is contained in:
@@ -1,15 +1,20 @@
|
||||
# Cloudron Packages for Knowne ELement Enterprises
|
||||
# 🛰️ CloudronStack
|
||||
|
||||
CloudronStack contains Cloudron packaging artifacts for various upstream projects focused on different business capabilities. This stack serves as a catalog of third-party services grouped by capability for easy deployment and management.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Service Categories
|
||||
|
||||
This repository contains all of the Cloudron packaging artifacts for the following upstream projects:
|
||||
|
||||
|
||||
## Monitoring & Observability
|
||||
### Monitoring & Observability
|
||||
- https://github.com/getsentry/sentry
|
||||
- https://github.com/healthchecks/healthchecks
|
||||
- https://github.com/SigNoz/signoz
|
||||
- https://github.com/target/goalert
|
||||
|
||||
## Security & Compliance
|
||||
### Security & Compliance
|
||||
- https://github.com/fleetdm/fleet
|
||||
- https://github.com/GemGeorge/SniperPhish
|
||||
- https://github.com/gophish/gophish
|
||||
@@ -20,7 +25,7 @@ This repository contains all of the Cloudron packaging artifacts for the followi
|
||||
- https://github.com/todogroup/policies
|
||||
- https://github.com/wiredlush/easy-gate
|
||||
|
||||
## Developer Platforms & Automation
|
||||
### Developer Platforms & Automation
|
||||
- https://github.com/adnanh/webhook
|
||||
- https://github.com/huginn/huginn
|
||||
- https://github.com/metrue/fx
|
||||
@@ -30,7 +35,7 @@ This repository contains all of the Cloudron packaging artifacts for the followi
|
||||
- https://github.com/stephengpope/no-code-architects-toolkit
|
||||
- https://github.com/windmill-labs/windmill
|
||||
|
||||
## Infrastructure & Operations
|
||||
### Infrastructure & Operations
|
||||
- https://github.com/apache/apisix
|
||||
- https://github.com/fonoster/fonoster
|
||||
- https://github.com/mendersoftware/mender
|
||||
@@ -39,7 +44,7 @@ This repository contains all of the Cloudron packaging artifacts for the followi
|
||||
- https://github.com/rundeck/rundeck
|
||||
- https://github.com/SchedMD/slurm
|
||||
|
||||
## Data & Analytics
|
||||
### Data & Analytics
|
||||
- https://github.com/apache/seatunnel
|
||||
- https://github.com/datahub-project/datahub
|
||||
- https://github.com/gristlabs/grist-core
|
||||
@@ -47,7 +52,7 @@ This repository contains all of the Cloudron packaging artifacts for the followi
|
||||
- https://github.com/langfuse/langfuse
|
||||
- https://github.com/nautechsystems/nautilus_trader
|
||||
|
||||
## Business & Productivity
|
||||
### Business & Productivity
|
||||
- https://github.com/cortezaproject/corteza
|
||||
- https://github.com/HeyPuter/puter
|
||||
- https://github.com/inventree/InvenTree
|
||||
@@ -63,7 +68,7 @@ This repository contains all of the Cloudron packaging artifacts for the followi
|
||||
- https://github.com/PLMore/PLMore
|
||||
- https://github.com/sebo-b/warp
|
||||
|
||||
## Industry & Specialized Solutions
|
||||
### Industry & Specialized Solutions
|
||||
- https://github.com/BOINC/boinc
|
||||
- https://github.com/chirpstack/chirpstack
|
||||
- https://github.com/consuldemocracy/consuldemocracy
|
||||
@@ -74,3 +79,37 @@ This repository contains all of the Cloudron packaging artifacts for the followi
|
||||
- https://github.com/Resgrid/Core
|
||||
- https://github.com/wireviz/wireviz-web
|
||||
- https://github.com/wireviz/WireViz
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
To use these Cloudron packages:
|
||||
|
||||
1. Navigate to the CloudronStack directory:
|
||||
```bash
|
||||
cd CloudronStack
|
||||
```
|
||||
|
||||
2. Review the `collab/` directory for planning documents and collaboration notes:
|
||||
```bash
|
||||
ls -la collab/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Working Agreement
|
||||
- **Stacks stay in sync.** When you add or modify automation, update both the relevant stack README and any linked prompts/docs.
|
||||
- **Collab vs Output.** Use `collab/` for planning and prompts, keep runnable artifacts under `output/`.
|
||||
- **Document forward.** New workflows should land alongside tests and a short entry in the appropriate README table.
|
||||
- **AI Agent Coordination.** Use Qwen agents for documentation updates, code changes, and maintaining consistency across stacks.
|
||||
|
||||
---
|
||||
|
||||
## 🤖 AI Agent
|
||||
This stack is maintained by **CloudronBot**, an AI agent focused on CloudronStack documentation and packaging.
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
See [LICENSE](../LICENSE) for full terms. Contributions are welcome—open a discussion in the relevant stack's `collab/` area to kick things off.
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
# ♻️ LifecycleStack
|
||||
|
||||
## Overview
|
||||
LifecycleStack will eventually house the tooling and processes that manage the evolution of TSYSDevStack workloads—from ideation and delivery to ongoing operations. While the folder is in its inception phase, this README captures the intent and provides collaboration hooks for the future.
|
||||
|
||||
---
|
||||
|
||||
## Focus Areas
|
||||
| Stream | Description | Status |
|
||||
|--------|-------------|--------|
|
||||
@@ -10,10 +11,33 @@ LifecycleStack will eventually house the tooling and processes that manage the e
|
||||
| Observability Loop | Capture learnings from SupportStack deployments back into build workflows. | 🛠️ Planning |
|
||||
| Governance & Quality | Codify checklists, runbooks, and lifecycle metrics. | 🛠️ Planning |
|
||||
|
||||
## Collaboration Guidelines
|
||||
- Start proposals under `collab/` (create the directory when needed) to keep ideation separate from implementation.
|
||||
- Reference upstream stack READMEs (Cloudron, Support, Toolbox) when describing dependencies or hand-offs.
|
||||
- Keep diagrams and decision records in Markdown so they are versionable alongside code.
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
1. Navigate to the LifecycleStack directory:
|
||||
```bash
|
||||
cd LifecycleStack
|
||||
```
|
||||
|
||||
2. Review the `collab/` directory for planning documents and collaboration notes:
|
||||
```bash
|
||||
ls -la collab/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Working Agreement
|
||||
- **Stacks stay in sync.** When you add or modify automation, update both the relevant stack README and any linked prompts/docs.
|
||||
- **Collab vs Output.** Use `collab/` for planning and prompts, keep runnable artifacts under `output/`.
|
||||
- **Document forward.** New workflows should land alongside tests and a short entry in the appropriate README table.
|
||||
- **AI Agent Coordination.** Use Qwen agents for documentation updates, code changes, and maintaining consistency across stacks.
|
||||
|
||||
---
|
||||
|
||||
## 🤖 AI Agent
|
||||
This stack is maintained by **LifecycleBot**, an AI agent focused on LifecycleStack workflows.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
1. Draft an initial lifecycle charter outlining environments and promotion triggers.
|
||||
@@ -21,3 +45,8 @@ LifecycleStack will eventually house the tooling and processes that manage the e
|
||||
3. Incorporate ToolboxStack routines for reproducible release tooling.
|
||||
|
||||
> 📝 _Tip: If you are beginning new work here, open an issue or doc sketch that points back to this roadmap so the broader team can coordinate._
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
See [LICENSE](../LICENSE) for full terms. Contributions are welcome—open a discussion in the relevant stack's `collab/` area to kick things off.
|
||||
|
||||
0
LifecycleStack/collab/.gitkeep
Normal file
0
LifecycleStack/collab/.gitkeep
Normal file
55
QWEN.md
Normal file
55
QWEN.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Qwen Agent Development Log
|
||||
|
||||
Date: Wednesday, October 29, 2025
|
||||
|
||||
## Project Context
|
||||
|
||||
TSYSDevStack is a constellation of curated stacks that power rapid prototyping, support simulations, developer workspaces, and (soon) lifecycle orchestration for TSYS Group. The project consists of four main stacks:
|
||||
|
||||
- **CloudronStack**: Cloudron application packaging and upstream research
|
||||
- **LifecycleStack**: Promotion workflows, governance, and feedback loops
|
||||
- **SupportStack**: Demo environment for support tooling
|
||||
- **ToolboxStack**: Reproducible developer workspaces and containerized tooling
|
||||
|
||||
## Topside Role
|
||||
|
||||
As the Topside Qwen agent, I operate at the top level of the directory tree and am responsible for:
|
||||
|
||||
- Keeping the top-level README.md and each of the four subdirectory README.md files up to date
|
||||
- Performing general housekeeping tasks
|
||||
- Maintaining this top-level QWEN.md file for tracking work
|
||||
|
||||
## Development Guidelines
|
||||
|
||||
- All commits should be verbose/beautifully formatted
|
||||
- Use atomic commits
|
||||
- Use conventional commit format
|
||||
|
||||
## Git Configuration
|
||||
|
||||
- Commit template configured to enforce conventional commits
|
||||
- Template file: /home/localuser/TSYSDevStack/commit-template.txt
|
||||
|
||||
## Task Tracking
|
||||
|
||||
Current tasks and progress:
|
||||
- [x] Explore the current directory structure in depth
|
||||
- [x] Create a QWEN.md file to track our work
|
||||
- [x] Review all subdirectory README.md files
|
||||
- [x] Update README.md files as needed throughout the project
|
||||
- [ ] Perform general housekeeping tasks as requested
|
||||
|
||||
## Work Log
|
||||
|
||||
### Session 1 (2025-10-29)
|
||||
- Oriented to the directory tree structure
|
||||
- Analyzed all README.md files in the project
|
||||
- Created QWEN.md file for tracking work
|
||||
- Set up commit configuration requirements
|
||||
- Updated all README.md files for consistency across the project:
|
||||
- Added Working Agreement section with consistent items
|
||||
- Added AI Agent section identifying the responsible bot
|
||||
- Added License section with reference to main LICENSE
|
||||
- Fixed CloudronStack README title and content
|
||||
- Created missing collab directory in LifecycleStack
|
||||
- Created top-level commit template and configured git
|
||||
11
README.md
11
README.md
@@ -37,10 +37,21 @@
|
||||
|
||||
---
|
||||
|
||||
## 🤖 AI Collaboration
|
||||
This project uses Qwen AI agents for development and maintenance:
|
||||
- **Topside**: Manages top-level README.md and directory structure
|
||||
- **CloudronBot**: Handles CloudronStack documentation and packaging
|
||||
- **LifecycleBot**: Manages LifecycleStack workflows
|
||||
- **SupportBot**: Maintains SupportStack operations
|
||||
- **ToolboxBot**: Handles ToolboxStack workspace management
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Working Agreement
|
||||
- **Stacks stay in sync.** When you add or modify automation, update both the relevant stack README and any linked prompts/docs.
|
||||
- **Collab vs Output.** Use `collab/` for planning and prompts, keep runnable artifacts under `output/`.
|
||||
- **Document forward.** New workflows should land alongside tests and a short entry in the appropriate README table.
|
||||
- **AI Agent Coordination.** Use Qwen agents for documentation updates, code changes, and maintaining consistency across stacks.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ The SupportStack delivers a curated demo environment for customer support toolin
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
## 🚀 Quick Start
|
||||
1. Export or edit variables in `output/TSYSDevStack-SupportStack-Demo-Settings`.
|
||||
2. Use the control script to manage the stack:
|
||||
```bash
|
||||
@@ -31,7 +31,25 @@ The SupportStack delivers a curated demo environment for customer support toolin
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Working Agreement
|
||||
- **Stacks stay in sync.** When you add or modify automation, update both the relevant stack README and any linked prompts/docs.
|
||||
- **Collab vs Output.** Use `collab/` for planning and prompts, keep runnable artifacts under `output/`.
|
||||
- **Document forward.** New workflows should land alongside tests and a short entry in the appropriate README table.
|
||||
- **AI Agent Coordination.** Use Qwen agents for documentation updates, code changes, and maintaining consistency across stacks.
|
||||
|
||||
---
|
||||
|
||||
## 🤖 AI Agent
|
||||
This stack is maintained by **SupportBot**, an AI agent focused on SupportStack operations.
|
||||
|
||||
---
|
||||
|
||||
## Collaboration Notes
|
||||
- Keep demo automation in `output/` and exploratory material in `collab/`.
|
||||
- When adding a new service, update both the compose files and the test suite to maintain coverage.
|
||||
- Synchronize documentation changes with any updates to automation or configuration—future contributors rely on the README table as the source of truth.
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
See [LICENSE](../LICENSE) for full terms. Contributions are welcome—open a discussion in the relevant stack's `collab/` area to kick things off.
|
||||
|
||||
@@ -29,4 +29,22 @@ Use `./run.sh down` to stop the container when you are finished.
|
||||
## Contribution Tips
|
||||
- Document every tooling change in both the `PROMPT` and `README.md`.
|
||||
- Prefer installing CLIs via `aqua` and language runtimes via `mise` to keep the environment reproducible.
|
||||
- Keep cache directories (`.build-cache/`, mise mounts) out of Git—they are already covered by the repo’s `.gitignore`.
|
||||
- Keep cache directories (`.build-cache/`, mise mounts) out of Git—they are already covered by the repo's `.gitignore`.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Working Agreement
|
||||
- **Stacks stay in sync.** When you add or modify automation, update both the relevant stack README and any linked prompts/docs.
|
||||
- **Collab vs Output.** Use `collab/` for planning and prompts, keep runnable artifacts under `output/`.
|
||||
- **Document forward.** New workflows should land alongside tests and a short entry in the appropriate README table.
|
||||
- **AI Agent Coordination.** Use Qwen agents for documentation updates, code changes, and maintaining consistency across stacks.
|
||||
|
||||
---
|
||||
|
||||
## 🤖 AI Agent
|
||||
This stack is maintained by **ToolboxBot**, an AI agent focused on ToolboxStack workspace management.
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
See [LICENSE](../LICENSE) for full terms. Contributions are welcome—open a discussion in the relevant stack's `collab/` area to kick things off.
|
||||
15
commit-template.txt
Normal file
15
commit-template.txt
Normal file
@@ -0,0 +1,15 @@
|
||||
# Please use conventional commit format: type(scope): description
|
||||
# Example: feat(auth): add jwt token expiration
|
||||
#
|
||||
# Types: feat, fix, docs, style, refactor, test, chore, perf, ci, build, revert
|
||||
#
|
||||
# Explain what and why in imperative mood:
|
||||
#
|
||||
#
|
||||
#
|
||||
# Signed-off-by: Your Name <your.email@example.com>
|
||||
#
|
||||
# ------------------------ >8 ------------------------
|
||||
# Do not modify or remove the line above.
|
||||
# Everything below it will be ignored.
|
||||
diff --git a/...
|
||||
Reference in New Issue
Block a user