Update changelog docs for CDN TTL details#3679
Conversation
|
|
||
| If you're making last-minute changes and ad hoc releases with changelog files that aren't uploaded to the public CDN yet, pass the `--force-local` command option to `changelog bundle`. | ||
|
|
||
| If you rely on CDN sourcing, wait at least an hour after your final changelog updates before you create the bundle. |
| You can further limit the possible values with the [products](/contribute/configure-changelogs-ref.md#products) and [lifecycles](/contribute/configure-changelogs-ref.md#lifecycles) options in the changelog configuration file. | ||
| ::: | ||
|
|
||
| ## Upload changelog files [upload] |
There was a problem hiding this comment.
We shouldn't document folks manually uploading changelogs on the command line.
Everything should be automated through our github actions and the timing of publishing these should not be arbitrary.
There was a problem hiding this comment.
I think the need for that will persist for the ad hoc releases and things like known issues, security issues, feature announcements, etc that aren't ncessary tied to a PR or release. AFAIK those aren't uploaded automatically yet.
| Changelog entries are uploaded into `changelog/{org}/{repo}/{branch}/{filename}`. | ||
|
|
||
| :::{note} | ||
| It can take between 60 seconds to an hour before updates appear in the public CDN. |
|
Heads up: the "wait up to an hour" behavior this PR documents is being removed at the source. elastic/docs-infra#355 disables CloudFront caching entirely for the changelog-bundles CDN (the 1-hour default TTL was the whole delay — the scrubber Lambda sets no Once that lands, the only delay between upload and public visibility is the private-bucket → SQS → scrubber-Lambda pipeline, which is seconds — so the TTL notes here ("minimum 60 seconds", "wait at least an hour after last-minute changelog updates before bundling") will be obsolete and worth rewording to describe just the scrubber pipeline delay. The entry-sourcing / |
This PR updates the changelog documentation (e.g. https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/changelog) related to issues I've hit when doing recent Serverless releases.
In particular, it adds more details about: