Skip to content

Commit 320ae7d

Browse files
committed
Update documentation to reference central wiki
- Updated README.md to link to eagle-dev-guides wiki - Removed old docs/ARCHITECTURE.md, DEPLOYMENT.md - Deleted empty docs/ folder - All general documentation now centralized in wiki
1 parent 1253f33 commit 320ae7d

File tree

3 files changed

+13
-928
lines changed

3 files changed

+13
-928
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
Admin site project for management of EPIC
44

5+
## Documentation
6+
7+
All documentation has been consolidated in the [Eagle Documentation Wiki](https://github.com/bcgov/eagle-dev-guides/wiki):
8+
9+
* **[Architecture Overview](https://github.com/bcgov/eagle-dev-guides/wiki/Architecture-Overview)** - System components and request flow
10+
* **[Configuration Management](https://github.com/bcgov/eagle-dev-guides/wiki/Configuration-Management)** - ConfigService pattern and environment variables
11+
* **[Deployment Pipeline](https://github.com/bcgov/eagle-dev-guides/wiki/Deployment-Pipeline)** - CI/CD workflows and procedures
12+
* **[Helm Charts](https://github.com/bcgov/eagle-dev-guides/wiki/Helm-Charts)** - Kubernetes deployment configuration
13+
* **[Local Development](https://github.com/bcgov/eagle-dev-guides/wiki/Local-Development)** - Setting up your development environment
14+
* **[Rollback Procedures](https://github.com/bcgov/eagle-dev-guides/wiki/Rollback-Procedures)** - How to rollback deployments
15+
* **[Troubleshooting](https://github.com/bcgov/eagle-dev-guides/wiki/Troubleshooting)** - Common issues and solutions
16+
517
## Related projects
618

719
Eagle is a revision name of the EAO EPIC application suite.
@@ -85,13 +97,7 @@ yarn test-ci
8597

8698
## CI/CD Pipeline
8799

88-
The EPIC project has moved away from PR based pipeline due to complexity and reliability concerns of the PR based pipeline implementation. The current CI/CD pipeline utilizes Github Actions to build Docker images and push them back into the BC Gov OpenShift Docker registry.
89-
90-
A full description and guide to the EPIC pipeline and branching strategy is available in the [eagle-dev-guides](https://github.com/bcgov/eagle-dev-guides/blob/master/dev_guides/github_action_pipeline.md) repository.
91-
92-
## Angular Code scaffolding
93-
94-
A brief guide to Angular CLI's code scaffolding can be found in [eagle-dev-guides](https://github.com/bcgov/eagle-dev-guides/blob/master/dev_guides/angular_scaffolding.md)
100+
See the [Deployment Pipeline](https://github.com/bcgov/eagle-dev-guides/wiki/Deployment-Pipeline) documentation in the central wiki for complete CI/CD workflow information.
95101

96102

97103
## How to Contribute

0 commit comments

Comments
 (0)