Skip to content

Commit 13fd54d

Browse files
docs: update README
1 parent 5d2e013 commit 13fd54d

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,51 @@
11
# project-ops
22

33
A machine-parsable directory of operational details for Code for Philly projects.
4+
5+
## Repository Structure
6+
7+
Each project is represented by a directory containing two YAML files:
8+
9+
- `development.yaml`: Contains the project's GitHub repository information
10+
- `hosting.yaml`: Contains domain and deployment configuration details
11+
12+
### Development Configuration
13+
14+
The `development.yaml` file specifies the GitHub repository where the project's code is hosted. Example:
15+
16+
```yaml
17+
repository: github.com/CodeForPhilly/example-project
18+
```
19+
20+
See [.schemas/development.json](.schemas/development.json) for the complete schema.
21+
22+
### Hosting Configuration
23+
24+
The `hosting.yaml` file defines:
25+
26+
- Domain names and their registrar information
27+
- Deployment environments (production/staging) and their URLs
28+
29+
Example:
30+
31+
```yaml
32+
domains:
33+
- name: example.com
34+
registrar: namecheap-codeforphilly
35+
expiration: 2025-12-31
36+
37+
deployments:
38+
- name: production
39+
environment: cfp-live-cluster
40+
urls:
41+
- https://example.com
42+
- https://www.example.com
43+
```
44+
45+
See [.schemas/hosting.json](.schemas/hosting.json) for the complete schema.
46+
47+
## Development
48+
49+
### Schema Validation
50+
51+
The repository includes JSON Schema definitions in the `.schemas/` directory that provide validation and autocompletion in VSCode while editing the YAML files with the "YAML" VSCode extension by Red Had installed.

0 commit comments

Comments
 (0)