Closed markmandel closed 5 years ago
Started pottering on this a bit: https://github.com/markmandel/agones/tree/feature/website
Here's the live demo I'm working with at the moment, so people can keep track. https://agones-mark.appspot.com/site/
It needs some reorganising - but I'm going to try and get all the current documentation in it first, and then we can work on cleaning up the structure.
/cc @thisisnotapril - figure you might be interested :wave: - work in progress, and all that.
Website now has all the markdown content in it https://agones-mark.appspot.com/site/
Next steps:
Anything else I'm missing?
Comments, reviews, feedback appreciated.
Issue
Keeping our live documentation on github can be difficult when mixing documentation for features that are in development with features that are in the release.
Solution
We need a static site for Agones, that can be updated to the most recent version with each release, but also lets us review for each build.
Design
The site and documentation should remain in the Agones repo, so as to ensure that new features also are accompanied by documentation.
Risks
agones.dev
, as well as redirects for our helm chart repo, etc. So we will need to take that into account with our eventual hosting option for the new site (App Engine, netlify, something else). We could possibly solve this by hosting the docs on a subdomain, or integrating the static site with the current codebase that is served at agones.dev via App Engine (but isn't currently open source - but could be).Potential Solutions