Skip to content

Commit ce782c2

Browse files
committed
Update documentation to reference central wiki
- Updated README.md to link to eagle-dev-guides wiki - Removed old docs/ARCHITECTURE.md, CONFIGURATION.md, DEPLOYMENT.md, ANALYTICS_ARCHITECTURE.md - Kept eagle-api specific docs: ENVIRONMENT_CONFIGURATION.md, MONGODB_44_UPGRADE_PLAN.md - All general documentation now centralized in wiki
1 parent 3a84617 commit ce782c2

File tree

5 files changed

+9
-2994
lines changed

5 files changed

+9
-2994
lines changed

README.md

Lines changed: 9 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,15 @@ API for acting as a central authenticated data service for all EPIC front-ends
66

77
## Documentation
88

9-
Comprehensive architecture and deployment documentation is available in the [docs](./docs) directory:
10-
11-
* **[ARCHITECTURE.md](./docs/ARCHITECTURE.md)** - Platform architecture overview
12-
* Service map and request routing
13-
* Why `/api` bypasses rproxy (direct route architecture)
14-
* nginx configuration and caching strategy
15-
* Security and authentication flows
16-
* Monitoring and health checks
17-
18-
* **[ANALYTICS_ARCHITECTURE.md](./docs/ANALYTICS_ARCHITECTURE.md)** - Analytics integration
19-
* Penguin Analytics service architecture
20-
* Why `/analytics` is separate from `/api` path
21-
* Event schema and TimescaleDB storage
22-
* Frontend integration (AnalyticsService pattern)
23-
* Performance considerations and troubleshooting
24-
25-
* **[CONFIGURATION.md](./docs/CONFIGURATION.md)** - Configuration management
26-
* ConfigService pattern with runtime config fetching
27-
* Environment variables reference (dev/test/prod)
28-
* Build-time vs runtime configuration
29-
* Secrets management in OpenShift
30-
31-
* **[DEPLOYMENT.md](./docs/DEPLOYMENT.md)** - Deployment workflows
32-
* OpenShift namespace structure (6cdc9e-tools/dev/test/prod)
33-
* GitHub Actions CI/CD pipeline
34-
* Helm chart deployment
35-
* Environment promotion workflow (dev → test → prod)
36-
* Rollback procedures and troubleshooting
9+
All documentation has been consolidated in the [Eagle Documentation Wiki](https://github.com/bcgov/eagle-dev-guides/wiki):
10+
11+
* **[API Architecture](https://github.com/bcgov/eagle-dev-guides/wiki/API-Architecture)** - Service map, routing patterns, and request flow
12+
* **[Configuration Management](https://github.com/bcgov/eagle-dev-guides/wiki/Configuration-Management)** - ConfigService pattern and environment variables
13+
* **[Analytics Architecture](https://github.com/bcgov/eagle-dev-guides/wiki/Analytics-Architecture)** - Penguin Analytics integration
14+
* **[API Deployment](https://github.com/bcgov/eagle-dev-guides/wiki/API-Deployment)** - Deployment workflows and procedures
15+
* **[Deployment Pipeline](https://github.com/bcgov/eagle-dev-guides/wiki/Deployment-Pipeline)** - CI/CD workflows and image tagging
16+
* **[Rollback Procedures](https://github.com/bcgov/eagle-dev-guides/wiki/Rollback-Procedures)** - How to rollback deployments
17+
* **[Troubleshooting](https://github.com/bcgov/eagle-dev-guides/wiki/Troubleshooting)** - Common issues and solutions
3718

3819
## Related projects
3920

0 commit comments

Comments
 (0)