we currently generate and carry Foreman apipie docs in our theforeman.org github repo. These are autogenerated HTML pages and there is no reason to have them in the git repo - once these are generated we never change them. The api directory is currently sized 672 MB, we recently dropped some old versions:
There is some value in archiving those API documents however, people use really old Foreman versions and it might be handy to have them online. Also with the foreman new generation documentation which is hosted on a brand new site
docs.theforeman.org we need to move apipie docs as well.
So here is my proposal: let’s move all current apipie documents from our main site to one of infra subdomains or we can create a dedicated domain too. Then we will update links and create redirect document or httpd rules so old links are kept working. Finally we set up some process how to upload new documentation with coordination from the infra team.
We would start linking apipie docs from the new documentation as well. BIg advantage is that we can afford not to delete old versions, there should be plenty of space on our infra, we can even hardlink same files which many of them are not changing for years (via fsdupe utility or similar tools).