Page MenuHomePhabricator

Work out a way to keep documentation up to date
Open, HighPublic

Description

We could probably sling together a basic flask api that can call functions and read something like basic json and then return html as a response.

This would mean stuff for the version constant could be automatic and documentation dynamic and refreshed based on a simple script. We could see about putting a CDN in front of it to cache the html. Fosshost already have that functionality so that would be nice.

Details

Security
None

Event Timeline

I spoke to Nate from Fosshost and they don't seem to have configurable TTLs or manual cache purge. Cloudflare seem nice to open source so I'll reach out to them, assigning to @Zppix for approval.

Cloudflare don't seem to have CNAME support so unless they want to be really nice for open source, which they have been before based on google, we might have to register a domain with Fosshost and have documentation running of MirahezeBots.something but there's not much harm to that.

I like our URLs to be consistent, and that we find a way to host our own caching solution.

Approved as a trial basis.

I will set up the CDN for the current system later hopefully today and we should get the new system soon that's more dynamic and will bring the biggest impact.

In T160#2825, @Zppix wrote:

I like our URLs to be consistent, and that we find a way to host our own caching solution.

👍

Sario528 added a project: Documentation.