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.

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

Improve internal docs #13

Merged
merged 33 commits into from
Jun 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
be0cf9a
Fix shields
NathanFlurry Jun 17, 2023
2c1c149
WIP documenting bolt
NathanFlurry Jun 17, 2023
3b8b1ab
WIP documenting dependencies
NathanFlurry Jun 18, 2023
21ebd04
Reorg docs
NathanFlurry Jun 18, 2023
b71fcae
Format docs
NathanFlurry Jun 18, 2023
eb356cf
Reorg docs
NathanFlurry Jun 18, 2023
ce19734
Fix compile error
NathanFlurry Jun 18, 2023
941e39f
Merge branch 'feature/svc-2570' into feature/svc-2565
NathanFlurry Jun 18, 2023
d904c68
Rename docs
NathanFlurry Jun 18, 2023
689d023
Doc forward caching proxy
NathanFlurry Jun 18, 2023
1bc8c64
Update Salt troubleshooting
NathanFlurry Jun 18, 2023
6ec9219
More docs reorg
NathanFlurry Jun 18, 2023
d884b6e
Reorg
NathanFlurry Jun 18, 2023
af1b41e
Write project management doc
NathanFlurry Jun 18, 2023
57f0a82
Split up project management doc
NathanFlurry Jun 18, 2023
7c2551f
Add link checking config
NathanFlurry Jun 19, 2023
2e82129
Update developing locally docs
NathanFlurry Jun 19, 2023
8349bde
Add link checker
NathanFlurry Jun 19, 2023
c5095ed
Fix broken links
NathanFlurry Jun 19, 2023
a06504e
Rename workflow
NathanFlurry Jun 19, 2023
31715a2
Add oss docs
NathanFlurry Jun 19, 2023
3812561
Document missing features
NathanFlurry Jun 19, 2023
06ab985
Doc secrets
NathanFlurry Jun 19, 2023
6ec3e28
Doc feature flags
NathanFlurry Jun 19, 2023
94f4cae
Dev team spec
NathanFlurry Jun 19, 2023
186e53b
Doc dashboards
NathanFlurry Jun 19, 2023
798b3e6
Fix links
NathanFlurry Jun 19, 2023
d11fd65
Try to fix excludes
NathanFlurry Jun 19, 2023
03330f9
Don't run on both push and pr
NathanFlurry Jun 19, 2023
71745e3
Fix lychee config
NathanFlurry Jun 19, 2023
1ab4b11
Update banner
NathanFlurry Jun 19, 2023
8dfe814
Add debugging services
NathanFlurry Jun 19, 2023
70dd9a6
Link missing features
NathanFlurry Jun 19, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/links.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: link-checker

on: [push]

jobs:
linkChecker:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3

- name: Link Checker
uses: lycheeverse/lychee-action@v1.8.0
with:
fail: true
45 changes: 16 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
<p align="center">
<img alt="GitHub" src="https://img.shields.io/github/license/rivet-gg/rivet?style=flat-square">
<a href='http://makeapullrequest.com'><img alt='PRs Welcome' src='https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square'/></a>
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/rivet/rivet?style=flat-square"/>
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/rivet/rivet?style=flat-square"/>
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/rivet-gg/rivet?style=flat-square"/>
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/rivet-gg/rivet?style=flat-square"/>
</p>

<p align="center">
Expand All @@ -24,7 +24,7 @@
- [Serverless Lobbies](https://docs.rivet.gg/serverless-lobbies/introduction) for auto-scaling game lobbies
- [Flexible matchmaker](https://docs.rivet.gg/matchmaker/introduction) for placing players in lobbies with no wait times
- [CDN](https://docs.rivet.gg/cdn/introduction) for hosting assets and webpages with a custom domain or provided rivet.game subdomain
- [Game Guard](https://docs.rivet.gg/serverless-lobbies/concepts/game-guard) for DDoS mitigation and managed WebSocket SSL & TCP+TLS termination
- [Game Guard](https://docs.rivet.gg/serverless-lobbies/concepts/game-guard) for DDoS mitigation and managed WebSocket SSL, TCP+TLS, and UDP
- Streamlined DevOps for teams
- Unified logging & monitoring & analytics
- No downtime deploys with easy rollbacks
Expand All @@ -41,47 +41,34 @@

### Self-hosting

See the [setup guide](./doc/SETUP.md) to develop & deploy Rivet yourself.
See the [setup guide](/docs/getting_started/DEVELOPMENT.md) to develop & deploy Rivet yourself.

## 📐 Architecture

Below is a simplified architecture diagram of a Rivet cluster.

![Architecture](./media/simplified_architecture.png)
![Architecture](/media/simplified_architecture.png)

## 📖 Helpful Docs
## 📖 Documentation Overview

> **Looking for documentation on building a game with Rivet?**
>
> Visit our [documentation for game developers](https://docs.rivet.gg/)!

**Core Components**
**Getting Started**

- [Project Structure](/doc/PROJECT_STRUCTURE.md)
- [Bolt](/doc/bolt/README.md)
- [Chirp](/doc/chirp/README.md)
- [Project Structure](/docs/getting_started/PROJECT_STRUCTURE.md)
- [Developing on Rivet](/docs/getting_started/DEVELOPMENT.md)
- [Error Handling](/docs/libraries/chirp/ERROR_HANDLING.md)

**Operating a Rivet Cluster**
**Philosophy**

- [Developing Services](/doc/DEVELOPING_SERVICES.md)
- [Working with Databases](/doc/WORKING_WITH_DATABASES.md)
- [Terraform](/doc/tf/README.md)
- [SaltStack](/doc/saltstack/README.md)
- [Why open source](/docs/philosophy/WHY_OPEN_SOURCE.md)

**3rd Party Services**
**Architecture**

- Databases
- [Cockroach](/doc/cockroach/README.md)
- [ClickHouse](/doc/clickhouse/README.md)
- [Redis](/doc/redis/README.md)
- Infrastructure
- [Nomad](/doc/nomad/README.md)
- [Consul](/doc/consul/README.md)
- [Traefik](/doc/traefik/README.md)
- [Nebula](/doc/nebula/README.md)
- Development
- [Nix](/doc/nix/README.md)
- [Software Bill of Materials](/docs/infrastructure/SBOM.md)

**Writing services**
**About**

- [Error Handling](/doc/ERROR_HANDLING.md)
- [Notable missing features](/docs/about/MISSING_FEATURES.md)
30 changes: 0 additions & 30 deletions doc/AUTH.md

This file was deleted.

34 changes: 0 additions & 34 deletions doc/BUILD_HOSTING.md

This file was deleted.

29 changes: 0 additions & 29 deletions doc/DEBUGGING_MM.md

This file was deleted.

12 changes: 0 additions & 12 deletions doc/DEPLOY_STEPS.md

This file was deleted.

52 changes: 0 additions & 52 deletions doc/DEVELOPING_SERVICES.md

This file was deleted.

79 changes: 0 additions & 79 deletions doc/DEV_BINARY_SIZE_OPT.md

This file was deleted.

3 changes: 0 additions & 3 deletions doc/DEV_FIREWALLS.md

This file was deleted.

10 changes: 0 additions & 10 deletions doc/ENDPOINTS.md

This file was deleted.

17 changes: 0 additions & 17 deletions doc/ERROR_HANDLING.md

This file was deleted.

12 changes: 0 additions & 12 deletions doc/GENERATE_SSH_KEY_PAIR.md

This file was deleted.

Loading