Skip to content

Commit 46d7fdb

Browse files
authored
Enhance RUNBOOK with troubleshooting details
Added troubleshooting section with checklist for GitHub Pages setup.
1 parent 2cb3598 commit 46d7fdb

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

RUNBOOK.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
11
# Runbook
22

33
This documentation will help you operate the service provided by this codebase.
4+
5+
## Live Service
6+
7+
- [codebaseinterface.org](https://codebaseinterface.org/)
8+
9+
## Troubleshooting
10+
11+
The codebase interface website is provided through github pages via the organisation level pages setting which is then leveraged through this specific repo called codebase-interface.github.io. This depends on DNS records being set in the namecheap domain provider and also the CNAME being present in the docs folder so that it can be copied across to the gh-pages branch.
12+
13+
### Checklist
14+
15+
- ✔️ - Github pages enabled at github organisation level.
16+
- ✔️ - Namecheap domain provider contains TXT record from organisation level.
17+
- ✔️ - Namecheap domain provider contains A records for github IP addresses.
18+
- ✔️ - Repo is named {organisation}.github.io.
19+
- ✔️ - Github pages enabled at the repo level.
20+
- ✔️ - CNAME present in mkdocs folder of main branch with contents codebaseinterface.org.
21+
- ✔️ - CNAME present in root of gh-pages branch with contents codebaseinterface.org.

0 commit comments

Comments
 (0)