googleforgames / agones

Dedicated Game Server Hosting and Scaling for Multiplayer Games on Kubernetes
https://agones.dev
Apache License 2.0
6.12k stars 818 forks source link

Website that contains documentation #410

Closed markmandel closed 5 years ago

markmandel commented 6 years ago

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

Potential Solutions

markmandel commented 5 years ago

Started pottering on this a bit: https://github.com/markmandel/agones/tree/feature/website

agones - google chrome_015

markmandel commented 5 years ago

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.

markmandel commented 5 years ago

/cc @thisisnotapril - figure you might be interested :wave: - work in progress, and all that.

markmandel commented 5 years ago

Website now has all the markdown content in it https://agones-mark.appspot.com/site/

Next steps:

  1. [x] Remove all the broken links that currently exist
  2. [x] Bring in the golang redirect logic for the canonical path and charts
  3. [x] Give the landing page some kind of copy
  4. [x] Integrate the link checker into the cloudbuild.yaml
  5. [x] Integrate google analytics
  6. [x] Integrate the search
  7. [x] Add a starter blog post!
  8. [x] Add a starter release post!
  9. [x] Flesh out some of the blank sections - like contributing to the docs, etc.
  10. [x] Delete the now duplicate markdown docs from the repo (or reduce their scope, and point to the new docs)
  11. [x] Integrate with Cloud Build to run tests and create previews on each build
  12. [x] Remove the :warning: blocks, and replace with date based published.

Anything else I'm missing?

Comments, reviews, feedback appreciated.