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

[Alpha Release] Let's write some documentation #62

Closed
10 tasks done
markmandel opened this issue Jun 24, 2020 · 6 comments
Closed
10 tasks done

[Alpha Release] Let's write some documentation #62

markmandel opened this issue Jun 24, 2020 · 6 comments
Labels
kind/documentation Improvements or additions to documentation kind/feature New feature or request

Comments

@markmandel
Copy link
Member

markmandel commented Jun 24, 2020 •
edited
Loading

We should write some docs.

  • Development guide
  • Configuration
  • Quickstarts
    • ncat
    • Agones & Agones w/ compression
  • Writing Filters
  • Individual Filters
  • UDP Session Management
  • List available metrics
  • FAQ
@markmandel markmandel added kind/documentation Improvements or additions to documentation kind/feature New feature or request labels Jun 24, 2020
@markmandel
Copy link
Member Author

Thoughts on this:

  1. To get started, we can do a /docs folder in this github repo to write our first pass at documentation
  2. We can probably also (eventually?) leverage docs.rs, so where relevant, we should document our user-interactable components appropriately. E.g. Writing filters is a really good example.

iffyio added a commit that referenced this issue Aug 23, 2020
@iffyio
Add filters docs and external doc tests support
d98d60f 
* Add external documentation under `/docs` around filters
  and their configuration.
* Add support for running tests in external docs. This includes
  adding a nightly compiler and updating cloudbuild to run them
  in ci.

Work on #62
@iffyio iffyio mentioned this issue Aug 23, 2020
Merged
iffyio added a commit that referenced this issue Aug 23, 2020
@iffyio
Add filters docs and external doc tests support
0709363 
* Add external documentation under `/docs` around filters
  and their configuration.
* Add support for running tests in external docs. This includes
  adding a nightly compiler and updating cloudbuild to run them
  in ci.

Work on #62
markmandel added a commit that referenced this issue Aug 25, 2020
@iffyio @markmandel
Add filters docs and external doc tests support (#89)
b8e6b7f 
* Add filters docs and external doc tests support

* Add external documentation under `/docs` around filters
  and their configuration.
* Add support for running tests in external docs. This includes
  adding a nightly compiler and updating cloudbuild to run them
  in ci.

Work on #62

* fix cargo fmt

* Use cargo --tests and fix debug filter schema doc

Co-authored-by: Mark Mandel <markmandel@google.com>
markmandel added a commit that referenced this issue Nov 17, 2020
@markmandel
Add an overview to the documentation
a3d9ffa 
Work on #62
@markmandel markmandel mentioned this issue Nov 17, 2020
Merged
markmandel added a commit that referenced this issue Nov 17, 2020
@markmandel @iffyio
Add an overview to the documentation (#137)
17fcde4 
* Add an overview to the documentation

Work on #62

Co-authored-by: Ifeanyi Ubah <ifeanyi.ubah@embark-studios.com>
markmandel added a commit that referenced this issue Nov 17, 2020
@markmandel
Add example integration architecture documentation
e4854bc 
Provided some example integration architectures as starting points for
people looking to integrate Quilkin into their systems.

Work on #62
@markmandel markmandel mentioned this issue Nov 17, 2020
Merged
markmandel added a commit that referenced this issue Nov 18, 2020
@markmandel
Add example integration architecture documentation (#139)
c802955 
Provided some example integration architectures as starting points for
people looking to integrate Quilkin into their systems.

Work on #62
@markmandel
Copy link
Member Author

Added

  • UDP Session Management
  • List available metrics

@markmandel markmandel changed the title Let's write some documentation [Alpha Release] Let's write some documentation Apr 27, 2021
@markmandel
Copy link
Member Author

Changed the title to be specific to the Alpha release.

Added a FAQ to the list (I have some thoughts on some questions that should go in there - mac binary, consoles, performance, why not envoy 😄). Outside of "writing a Filter", I think that's all the documentation we probably want for the alpha release?

What do you think? Happy with those items, anything else we should add?

@markmandel markmandel pinned this issue Apr 27, 2021
@markmandel
Copy link
Member Author

Added a checkbox set for quickstarts. Working on a quickstart for Agones, and extending that to using a Compression filter as well.

@markmandel
Copy link
Member Author

AI from meeting today.
@markmandel will finish off the Agones quickstart, and write a FAQ

@iffyio writing a "So you want to add your own Filter?" doc.

markmandel added a commit that referenced this issue Apr 29, 2021
@markmandel
Quickstart for Agones + Quilkin
d608f49 
Utilises the Agones example to do a walkthrough of running Xonotic with
a sidecar, and also to do client side compression to server side
decompression.

Note: Won't work out of the box until we do our initial release. To test
edit the sidecar.yaml and sidecar-compress.yaml to point at a dev image
of Quilkin in your project.

Work on #62
@markmandel markmandel mentioned this issue Apr 29, 2021
Merged
markmandel added a commit that referenced this issue Apr 30, 2021
@markmandel
It's a FAQ
19392b4 
Work on #62
@markmandel markmandel mentioned this issue Apr 30, 2021
Merged
markmandel added a commit that referenced this issue Apr 30, 2021
@markmandel
Quickstart for Agones + Quilkin (#235)
2e43e79 
Utilises the Agones example to do a walkthrough of running Xonotic with
a sidecar, and also to do client side compression to server side
decompression.

Note: Won't work out of the box until we do our initial release. To test
edit the sidecar.yaml and sidecar-compress.yaml to point at a dev image
of Quilkin in your project.

Work on #62
markmandel added a commit that referenced this issue Apr 30, 2021
@markmandel
It's a FAQ
7bdacbc 
Work on #62
markmandel added a commit that referenced this issue May 3, 2021
@markmandel
It's a FAQ (#238)
7d8996d 
* It's a FAQ

Work on #62

* Review updates.
iffyio added a commit that referenced this issue May 4, 2021
@iffyio
Add documentation for writing filters
5fdb126 
Work on #62
@iffyio iffyio mentioned this issue May 4, 2021
Merged
markmandel added a commit that referenced this issue May 12, 2021
@iffyio @markmandel
Add documentation for writing filters (#243)
52a58ec 
* Add documentation for writing filters

Work on #62

Co-authored-by: Mark Mandel <markmandel@google.com>
@markmandel
Copy link
Member Author

Closing this ticket, as we're now complete with the list of items to document before our 0.1.0 release 🙌🏻

@markmandel markmandel unpinned this issue May 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/documentation Improvements or additions to documentation kind/feature New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@markmandel