what this is
This commit is contained in:
parent
be3d77837e
commit
cd4b824b00
4 changed files with 132 additions and 6 deletions
50
docs/MAINTENANCE.md
Normal file
50
docs/MAINTENANCE.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
# Maintenance guide
|
||||
|
||||
Use this guide when making regular content changes to the live static site.
|
||||
|
||||
## Safe change workflow
|
||||
|
||||
1. Start from an up-to-date `main`.
|
||||
2. Create a branch.
|
||||
3. Edit the smallest set of files needed.
|
||||
4. Start a local server from the repo root:
|
||||
|
||||
```bash
|
||||
python3 -m http.server 8000
|
||||
```
|
||||
|
||||
5. Preview each changed page at `http://localhost:8000/`.
|
||||
6. Check that images, internal links, and forms still behave as expected.
|
||||
7. Commit, push, and open a PR into `main`.
|
||||
|
||||
## What to edit first
|
||||
|
||||
For a maintained public website, prioritize these pages:
|
||||
|
||||
- `index.html`
|
||||
- `about-us/index.html`
|
||||
- `contact/index.html`
|
||||
- `events/index.html`
|
||||
- `services/index.html`
|
||||
- `videos/index.html`
|
||||
|
||||
These are the most visitor-facing pages. Archive pages can be improved later
|
||||
unless they contain broken links or outdated information that visitors rely on.
|
||||
|
||||
## What to avoid
|
||||
|
||||
- Do not rename public route folders without a redirect plan.
|
||||
- Do not edit `.forgejo/` for content or design changes.
|
||||
- Do not add build tools, package managers, or framework dependencies.
|
||||
- Do not delete WordPress-looking assets just because they look unused. Verify
|
||||
references first with `rg` and a browser preview.
|
||||
|
||||
## Suggested cleanup order
|
||||
|
||||
1. Confirm contact details, service times, and current event information.
|
||||
2. Check the core pages on desktop and mobile.
|
||||
3. Fix broken internal links and missing images.
|
||||
4. Remove or adjust forms that cannot submit on a static site.
|
||||
5. Clean duplicated WordPress metadata only after confirming pages render the same.
|
||||
6. Later, consider a tiny static templating workflow if shared navigation/footer
|
||||
edits become frequent.
|
||||
54
docs/SITE-STRUCTURE.md
Normal file
54
docs/SITE-STRUCTURE.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
# Site structure
|
||||
|
||||
This repository is the production source for `https://familyfed.bcgen.ie/`.
|
||||
Everything is served as static files, so file paths are also URL paths.
|
||||
|
||||
## Do not casually move these
|
||||
|
||||
These top-level directories are public routes. Renaming or moving them changes
|
||||
the live URL unless redirects are added at the hosting layer.
|
||||
|
||||
- `about-us/`
|
||||
- `contact/`
|
||||
- `events/`
|
||||
- `register/`
|
||||
- `services/`
|
||||
- `speeches/`
|
||||
- `the-founders/`
|
||||
- `videos/`
|
||||
- `2013-sunday-service-archive/` through `2018-sunday-service-archive/`
|
||||
- `speeches-by-rev-dr-sun-myung-moon*/`
|
||||
- `speeches-of-rev-sun-myung-moon-1995/`
|
||||
- `blog/`
|
||||
|
||||
## Main content groups
|
||||
|
||||
| Group | Paths | Notes |
|
||||
| --- | --- | --- |
|
||||
| Core pages | `index.html`, `about-us/`, `contact/`, `events/`, `register/`, `services/`, `the-founders/`, `videos/` | Best first targets for active maintenance. |
|
||||
| Sunday service archives | `2013-sunday-service-archive/` to `2018-sunday-service-archive/`, plus `services/` | Mostly link lists to Vimeo or YouTube. |
|
||||
| Speeches archive | `speeches/`, `speeches-by-rev-dr-sun-myung-moon*/`, `speeches-of-rev-sun-myung-moon-1995/` | Large historical text archive. |
|
||||
| Blog mirror | `blog/` | Generated archive, category, tag, and dated pages. |
|
||||
| WordPress-style assets | `wp-content/`, `wp-includes/`, `wp/`, `cdn-cgi/` | Static leftovers from the original WordPress export. Keep paths stable while pages still reference them. |
|
||||
|
||||
## Asset locations
|
||||
|
||||
- Theme CSS, JavaScript, fonts, and images live under `wp-content/themes/parabola/`.
|
||||
- Plugin CSS and JavaScript live under `wp-content/plugins/`.
|
||||
- Uploaded images and PDFs live under `wp-content/uploads/` and `wp/wp-content/uploads/`.
|
||||
- Cloudflare email decoding support lives under `cdn-cgi/`.
|
||||
|
||||
For new production images or PDFs, prefer adding them under `wp-content/uploads/YYYY/MM/`
|
||||
until the site has a cleaner asset convention. That keeps the project consistent
|
||||
with the current exported pages.
|
||||
|
||||
## Maintenance notes
|
||||
|
||||
- Use a local web server when previewing: `python3 -m http.server 8000`.
|
||||
- Check pages at `http://localhost:8000/...`, not by opening files directly.
|
||||
- Keep edits small and URL-aware.
|
||||
- When editing shared header, navigation, or footer markup, remember that the
|
||||
markup is duplicated across many HTML files.
|
||||
- Leftover WordPress endpoints such as `/wp-json/`, `/xmlrpc.php`, and
|
||||
`/wp-admin/admin-ajax.php` appear in exported markup. They are not live backend
|
||||
features in this static repo.
|
||||
Loading…
Add table
Add a link
Reference in a new issue