Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Have Django release note updates be prioritized #1797

Open
sarahboyce opened this issue Dec 6, 2024 · 1 comment
Open

[Docs] Have Django release note updates be prioritized #1797

sarahboyce opened this issue Dec 6, 2024 · 1 comment
Labels

Comments

@sarahboyce
Copy link
Contributor

When we do security releases, we publish the fix (with release notes) to all supported versions (currently main, 5.1, 5.0 and 4.2) at roughly the same time as us publishing the new version
We also publish a blog announcing the release and link the release notes

It takes a while for the docs to update (imagine this is a mixture of building and caching)
Last time it took about 1.5 hours before the release notes were updated

If it is possible, it would be great for the release notes to be updated quicker so that folks can see the information of the security release quicker (and the fellows can tell it "worked")


I mention security releases because normal releases have the fix and release notes merged before we publish a release and so these updates are available rather than us linking to empty release note pages

@sarahboyce sarahboyce added the docs label Dec 6, 2024
@bmispelon
Copy link
Member

I haven't had time to look into this properly, but I did find out that it's possible to ask sphinx to only build certain files and not the whole docs (by passing the list of files you want built at the end of the sphinx-build command). It doesn't really help with the fact that our docs are still only built hourly, but it might be a start.

One other possible solution would be to add a feature where admins/fellows could manually trigger a build of the documentation from the site, though that would require some kind of task runner (celery, ...).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants