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.

Sign up for GitHub

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

Jump to bottom

Website that contains documentation #410

Closed
markmandel opened this issue Nov 9, 2018 · 4 comments
Closed

Website that contains documentation #410

markmandel opened this issue Nov 9, 2018 · 4 comments
Assignees
@markmandel
Labels
area/user-experience Pertaining to developers trying to use Agones, e.g. SDK, installation, etc kind/documentation Documentation for Agones kind/feature New features for Agones
Milestone
0.8.0

Comments

@markmandel
Copy link
Member

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

  • There are redirect in place at agones.dev (running on app engine) that enable the canonical package of 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
@markmandel markmandel added kind/feature New features for Agones kind/documentation Documentation for Agones area/user-experience Pertaining to developers trying to use Agones, e.g. SDK, installation, etc labels Nov 9, 2018
@markmandel
Copy link
Member Author

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

agones - google chrome_015

@markmandel markmandel self-assigned this Jan 1, 2019
@markmandel
Copy link
Member Author

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
Copy link
Member Author

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

@markmandel
Copy link
Member Author

markmandel commented Jan 3, 2019 •
edited
Loading

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

Next steps:

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

Anything else I'm missing?

Comments, reviews, feedback appreciated.

@markmandel markmandel added this to the 0.8.0 milestone Jan 9, 2019
markmandel added a commit to markmandel/agones that referenced this issue Jan 18, 2019
@markmandel
Website for Agones
f068286 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features).

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 18, 2019
@markmandel
Website for Agones
b1732a5 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
@markmandel markmandel mentioned this issue Jan 18, 2019
Merged
markmandel added a commit to markmandel/agones that referenced this issue Jan 18, 2019
@markmandel
Website for Agones
be2ffc8 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 18, 2019
@markmandel
Website for Agones
b2de02f 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 18, 2019
@markmandel
Website for Agones
f3ebee6 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 22, 2019
@markmandel
Website for Agones
110a51f 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 22, 2019
@markmandel
Website for Agones
c2e777a 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 22, 2019
@markmandel
Website for Agones
d8bb7ea 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 23, 2019
@markmandel
Website for Agones
f53d3ea 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 23, 2019
@markmandel
Website for Agones
b918eef 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 23, 2019
@markmandel
Website for Agones
7198e65 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 23, 2019
@markmandel
Website for Agones
76ba758 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 23, 2019
@markmandel
Website for Agones
c59626c 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 23, 2019
@markmandel
Website for Agones
98fefd3 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit to markmandel/agones that referenced this issue Jan 23, 2019
@markmandel
Website for Agones
273f1f2 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
markmandel added a commit that referenced this issue Jan 24, 2019
@markmandel
Website for Agones
625728e 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes #410
aLekSer pushed a commit to aLekSer/agones that referenced this issue Jan 24, 2019
@markmandel @aLekSer
Website for Agones
0791b4d 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
pm7h pushed a commit to pm7h/agones that referenced this issue Feb 11, 2019
@markmandel @pm7h
Website for Agones
6ef9882 
This is a new static site for Agones, as well as the tools to enable people to
write documentation for new features, without it displaying until the feature
is released.

Integration with cloudbuild for previews is also build in (preview is the
current documentation + all the documentation for the new features), as well
as a link checker that runs as part of the test suite.

This also brings into the codebase all the redirect code for go-get as
well as the chart redirects as well.

Closes googleforgames#410
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@markmandel markmandel

Labels
area/user-experience Pertaining to developers trying to use Agones, e.g. SDK, installation, etc kind/documentation Documentation for Agones kind/feature New features for Agones
Projects
None yet
Milestone
0.8.0
Development

No branches or pull requests
1 participant
@markmandel