Docs: active-features bijgewerkt, features offering-schedule en website-seo; Contact-commentaar in appsettings actueel
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,27 @@
|
||||
# Offering schedule (offering-schedule)
|
||||
|
||||
- **Slug**: offering-schedule
|
||||
- **Type**: Feature (small), built outside the AI-DLC flow and documented afterwards
|
||||
- **Status**: Commits 8af156c and 32b98fe on `feature/contact-forms-module`; on the test hosts once CI run 109 is deployed (not merged, nothing in production)
|
||||
- **Affected components**: `SlpModularCms.Modules.Offerings` (+ Tests), `openapi/slpsoftware.v1.json`, frontend admin (`frontend/src/features/offerings`)
|
||||
- **Documented**: 2026-11-15
|
||||
- **Documentation Language**: English
|
||||
- **Conversation Language**: Dutch (user language)
|
||||
|
||||
> Not run through the AI-DLC stages; this file records what the code does. There are no `requirements`, `plans` or `audit.md`.
|
||||
|
||||
## Purpose
|
||||
|
||||
An offering (package) can be switched on or off and limited to a period, so it can be prepared in advance or retired without deleting it.
|
||||
|
||||
## Behaviour
|
||||
|
||||
| Item | Behaviour |
|
||||
|---|---|
|
||||
| Fields on `Offering` | `IsActive` (default true), `StartsAt?`, `EndsAt?` (UTC). Migration `20261115100000_AddOfferingSchedule`. |
|
||||
| Live | An offering is live when it is switched on, `StartsAt` is empty or not in the future, and `EndsAt` is empty or still in the future (`OfferingSchedule.IsLive`). |
|
||||
| Public list | `GET /api/v1/offerings` returns **only live offerings**, evaluated at request time. Consumers that fetch at build time (the ASF website) therefore get the schedule as it is at the build moment. |
|
||||
| Administrator list | `GET /api/v1/offerings/all` (AdminOnly) returns every offering including switched-off, planned and expired ones, with `isActive`, `startsAt` and `endsAt`. |
|
||||
| Create / update | `CreateOfferingRequest` / `UpdateOfferingRequest` accept `isActive`, `startsAt`, `endsAt`; the schedule is validated (`OfferingSchedule.Validate`, end must be after start). |
|
||||
| Cache | Every change invalidates the host's index.html cache (SpaFallback hosts), so the SLP markers refresh at once. A schedule boundary that passes on its own is picked up when the cache entry expires (about 60 seconds). |
|
||||
| Admin UI | The package form has the schedule fields and a Cancel button; the featured star keeps the schedule. The list loads `/offerings/all`. |
|
||||
@@ -0,0 +1,29 @@
|
||||
# Website SEO on the CMS host (website-seo)
|
||||
|
||||
- **Slug**: website-seo
|
||||
- **Type**: Feature (small), built outside the AI-DLC flow and documented afterwards
|
||||
- **Status**: Commits a7460a0, 284ff1f (2026-11-11) and 32b98fe on `feature/contact-forms-module`; on the SLP test host (not merged, nothing in production)
|
||||
- **Affected components**: `SlpModularCms.Core` (`Hosting/Website`), `SlpModularCms.Modules.Offerings` (index markers), `SlpModularCms.Api.SlpSoftware/appsettings.json`
|
||||
- **Documented**: 2026-11-15
|
||||
- **Documentation Language**: English
|
||||
- **Conversation Language**: Dutch (user language)
|
||||
|
||||
> Not run through the AI-DLC stages; this file records what the code does. There are no `requirements`, `plans` or `audit.md`.
|
||||
|
||||
## Scope
|
||||
|
||||
Only hosts in `WebsiteMode.SpaFallback` (SlpSoftware). The ASF host (`PrerenderedPages`) registers none of this: that site builds its own canonical, og, JSON-LD and sitemap.
|
||||
|
||||
## Behaviour (`Website` configuration section)
|
||||
|
||||
| Setting | Effect |
|
||||
|---|---|
|
||||
| `NoIndex` (default `true`, fail-safe) | `X-Robots-Tag: noindex, nofollow` on every response; `/robots.txt` is `Disallow: /`; no sitemap. **Production must set `Website__NoIndex=false`.** |
|
||||
| `PublicBaseUrl` | Absolute address of the instance. With `NoIndex=false`: `/robots.txt` allows all and points to `{PublicBaseUrl}/sitemap.xml`; `/sitemap.xml` lists `Sitemap:Paths` (no `lastmod`). Production: `https://slpsoftware.nl`. |
|
||||
| `AuthoredBaseUrl` | The address the static `index.html` is written with. On a test instance with its own `PublicBaseUrl`, the host replaces the authored address by `PublicBaseUrl` in the served HTML (canonical, og, JSON-LD). Equal on production, so nothing changes. Only the configured value is used, never the request's Host header. |
|
||||
| `KnownPaths` | Only these paths are pages (200, the SPA shell); any other website path is a real 404 (still the shell). `/api`, `/admin` and assets keep working. |
|
||||
| `Sitemap:Paths` | Paths listed in the sitemap. |
|
||||
|
||||
## Index markers (`IndexHtmlInjector`)
|
||||
|
||||
The host fills markers in `index.html`: `<!--SLP:OFFERINGS-JSON-LD-->` (schema.org `ItemList` of `Offer`) and `<!--SLP:OFFERINGS-HTML-->` (a static `#packages-static` list), rendered by `OfferingsIndexMarkers` from the live offerings. 60-second cache, invalidated directly by every offering change, `ETag` with 304 support; if a provider fails the plain page is still served. The markers must stay in `<body>` above `#root`; the website removes `#packages-static` on start-up.
|
||||
Reference in New Issue
Block a user