Repositories & naming¶
Repositories for examplerep live under the GitHub organization and follow a prefix so lists sort cleanly and intent is obvious.
Prefixes¶
| Prefix | Purpose |
|---|---|
api- |
Backend HTTP services (for example, api-account). |
portal- |
Web applications aimed at humans (customer, partner, or internal). |
gitops- |
OpenShift manifests and Argo CD applications (cluster vs application repos as needed). |
iac- |
Foundation automation outside or beside GitOps (for example, cloud networking, Ansible). |
web- |
Web-adjacent projects that are not a product portal — for example, this documentation site (web-examplerep-project). |
Naming rules¶
- Use kebab-case end-to-end:
api-billing, notapi_billing. - Keep the slug after the prefix short and stable (
api-account, notapi-account-service-v2). - One deployable service per
api-*repo unless you have agreed a monorepo policy.
GitHub organization layout¶
Local development mirrors the organization on disk:
~/projects/github/examplerep/<repository_name>/
Example mapping¶
| Repository | Role |
|---|---|
api-account |
Account and customer domain API. |
portal-examplerep-external |
Public marketing site, enrollment flow, and customer portal. |
web-examplerep-project |
This internal documentation (MkDocs). |
Add rows here as new repositories are created.