Initial commit: add .gitignore and README
This commit is contained in:
224
PROJECT_TAXONOMY.md
Normal file
224
PROJECT_TAXONOMY.md
Normal file
@@ -0,0 +1,224 @@
|
||||
# Project Taxonomy & Categories
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Purpose**: Standardized taxonomy for categorizing and organizing projects
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
This document defines the standard taxonomy for categorizing projects in the workspace, including categories, tags, and metadata standards.
|
||||
|
||||
---
|
||||
|
||||
## Project Categories
|
||||
|
||||
### 1. Blockchain & DeFi
|
||||
Projects related to blockchain technology, decentralized finance, and cryptocurrency.
|
||||
|
||||
**Projects**:
|
||||
- 237-combo (DeFi Starter Kit)
|
||||
- 27-combi (Aave Stablecoin Looping Tool)
|
||||
- asle (Ali & Saum Liquidity Engine)
|
||||
- CurrenciCombo (ISO-20022 Combo Flow)
|
||||
- no_five (DBIS Atomic Amortizing Leverage Engine)
|
||||
- quorum-test-network (Quorum Dev Quickstart)
|
||||
- smom-dbis-138 (DeFi Oracle Meta Mainnet)
|
||||
- strategic (TypeScript CLI + Solidity Atomic Executor)
|
||||
|
||||
**Tags**: `blockchain`, `defi`, `solidity`, `ethereum`, `hyperledger`, `smart-contracts`
|
||||
|
||||
---
|
||||
|
||||
### 2. Banking & Financial Infrastructure
|
||||
Projects related to banking systems, financial services, and financial infrastructure.
|
||||
|
||||
**Projects**:
|
||||
- dbis_core (DBIS Core Banking System)
|
||||
- dbis_docs (DBIS Institutional Documentation)
|
||||
- the_order (Digital Identity Platform)
|
||||
- Aseret_Global monorepo projects
|
||||
- Elemental_Imperium (DBIS Tripartite Body)
|
||||
|
||||
**Tags**: `banking`, `financial`, `payments`, `compliance`, `iso20022`, `core-banking`
|
||||
|
||||
---
|
||||
|
||||
### 3. Cloud Infrastructure & DevOps
|
||||
Projects related to cloud infrastructure, DevOps, containerization, and infrastructure automation.
|
||||
|
||||
**Projects**:
|
||||
- loc_az_hci (Proxmox VE → Azure Arc → Hybrid Cloud Stack)
|
||||
- Sankofa (Sankofa Phoenix Cloud Platform)
|
||||
|
||||
**Tags**: `infrastructure`, `devops`, `kubernetes`, `azure`, `proxmox`, `hybrid-cloud`, `terraform`
|
||||
|
||||
---
|
||||
|
||||
### 4. Web Applications & Platforms
|
||||
Web-based applications and platforms for end users.
|
||||
|
||||
**Projects**:
|
||||
- Datacenter-Control-Complete (Datacenter Control System)
|
||||
- miracles_in_motion (Nonprofit Platform)
|
||||
- stinkin_badges (Badge Creation Platform PRO)
|
||||
|
||||
**Tags**: `web-app`, `platform`, `react`, `nextjs`, `frontend`, `fullstack`
|
||||
|
||||
---
|
||||
|
||||
### 5. Gaming & Metaverse
|
||||
Gaming and metaverse projects.
|
||||
|
||||
**Projects**:
|
||||
- metaverseDubai (Dubai Metaverse)
|
||||
|
||||
**Tags**: `gaming`, `metaverse`, `unreal-engine`, `3d`, `virtual-reality`
|
||||
|
||||
---
|
||||
|
||||
### 6. Documentation
|
||||
Documentation repositories.
|
||||
|
||||
**Projects**:
|
||||
- dbis_docs (DBIS Documentation)
|
||||
- panda_docs (Panda Documentation)
|
||||
- iccc_docs (ICCC Documentation)
|
||||
|
||||
**Tags**: `documentation`, `docs`, `markdown`, `knowledge-base`
|
||||
|
||||
---
|
||||
|
||||
## Project Metadata Standards
|
||||
|
||||
### Required Metadata
|
||||
- **Name**: Project name
|
||||
- **Status**: Active / Placeholder / Archived
|
||||
- **Category**: Primary category
|
||||
- **Tags**: List of tags
|
||||
- **Monorepo**: Monorepo name (if applicable)
|
||||
- **Last Updated**: Last update date
|
||||
|
||||
### Optional Metadata
|
||||
- **Technology Stack**: Technologies used
|
||||
- **Deployment Platform**: Where it's deployed
|
||||
- **Dependencies**: Key dependencies
|
||||
- **Maintainer**: Responsible team/person
|
||||
- **License**: License type
|
||||
- **Repository**: Git repository URL
|
||||
|
||||
---
|
||||
|
||||
## Status Definitions
|
||||
|
||||
### Active
|
||||
- Project is actively developed
|
||||
- Regular updates and maintenance
|
||||
- Production-ready or in active development
|
||||
|
||||
### Placeholder
|
||||
- Project is planned but not yet implemented
|
||||
- May have basic structure or documentation
|
||||
- Content pending or in planning phase
|
||||
|
||||
### Archived
|
||||
- Project is no longer actively maintained
|
||||
- Historical reference only
|
||||
- Content may be archived in separate location
|
||||
|
||||
---
|
||||
|
||||
## Tag System
|
||||
|
||||
### Technology Tags
|
||||
- `typescript`, `javascript`, `python`, `rust`, `go`, `solidity`
|
||||
- `react`, `nextjs`, `vue`, `angular`
|
||||
- `nodejs`, `express`, `fastify`, `nestjs`
|
||||
- `postgresql`, `mongodb`, `redis`
|
||||
- `kubernetes`, `docker`, `terraform`
|
||||
- `azure`, `aws`, `gcp`
|
||||
|
||||
### Domain Tags
|
||||
- `blockchain`, `defi`, `banking`, `financial`
|
||||
- `infrastructure`, `devops`, `cloud`
|
||||
- `identity`, `security`, `compliance`
|
||||
- `documentation`, `tools`, `utilities`
|
||||
|
||||
### Status Tags
|
||||
- `production`, `staging`, `development`, `deprecated`
|
||||
|
||||
---
|
||||
|
||||
## Project Relationships
|
||||
|
||||
### Hierarchical Relationships
|
||||
- **Monorepo → Submodules**: Parent-child relationship
|
||||
- **Platform → Services**: Platform hosting services
|
||||
|
||||
### Dependency Relationships
|
||||
- **Depends On**: Project requires another project
|
||||
- **Integrates With**: Project integrates with another project
|
||||
- **Provides Services For**: Project provides services for another
|
||||
|
||||
### Ecosystem Relationships
|
||||
- **DBIS Ecosystem**: dbis_core, dbis_docs, smom-dbis-138, Elemental_Imperium
|
||||
- **Sankofa Ecosystem**: Sankofa, PanTel (JV with PANDA)
|
||||
- **DeFi Ecosystem**: All Defi-Mix-Tooling projects
|
||||
- **Identity Ecosystem**: the_order, stinkin_badges
|
||||
|
||||
---
|
||||
|
||||
## Categorization Guidelines
|
||||
|
||||
### Primary Category
|
||||
- Choose the most relevant category
|
||||
- Based on primary purpose
|
||||
- One category per project
|
||||
|
||||
### Tags
|
||||
- Use multiple tags for better searchability
|
||||
- Include technology, domain, and status tags
|
||||
- Keep tags consistent across projects
|
||||
|
||||
### Metadata
|
||||
- Keep metadata up-to-date
|
||||
- Review quarterly
|
||||
- Update when project status changes
|
||||
|
||||
---
|
||||
|
||||
## Search and Discovery
|
||||
|
||||
### By Category
|
||||
Navigate to category section in main README
|
||||
|
||||
### By Tag
|
||||
Search for projects by technology, domain, or status tags
|
||||
|
||||
### By Relationship
|
||||
Follow relationship links between projects
|
||||
|
||||
### By Status
|
||||
Filter projects by active/placeholder/archived status
|
||||
|
||||
---
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Regular Updates
|
||||
- Review taxonomy quarterly
|
||||
- Update project categories as needed
|
||||
- Ensure metadata is current
|
||||
|
||||
### Adding New Projects
|
||||
1. Assign primary category
|
||||
2. Add appropriate tags
|
||||
3. Fill in metadata
|
||||
4. Document relationships
|
||||
5. Update main README
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-01-27
|
||||
**Next Review**: Q2 2025
|
||||
|
||||
Reference in New Issue
Block a user