From 4f257f06d6c3a9c711db21c09c87da12e371ef6f Mon Sep 17 00:00:00 2001 From: Marcel <34819524+MarcelCoding@users.noreply.github.com> Date: Sat, 12 Jun 2021 21:08:56 +0200 Subject: [PATCH 1/6] Updated CODEOWNERS --- .github/CODEOWNERS | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 247428c..d75d3b5 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,2 +1,4 @@ * @MarcelCoding -*.md @MarcelCoding @cryptic-game/text +*.md @cryptic-game/text @MarcelCoding +/docs/python/ @cryptic-game/text @cryptic-game/head-of-python-backend @cryptic-game/head-assistant-of-python-backend @Defelo +/docs/java/ @cryptic-game/text @cryptic-game/head-of-java-backend @cryptic-game/head-assistant-of-java-backend From 45898f7dbc44976e1b06d3fd70ab8685ccadc041 Mon Sep 17 00:00:00 2001 From: Jannik Emmerich Date: Sun, 13 Jun 2021 10:52:29 +0200 Subject: [PATCH 2/6] Update CODEOWNERS --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index d75d3b5..fbf369c 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,4 @@ -* @MarcelCoding +* @JannikEmmerich @MarcelCoding *.md @cryptic-game/text @MarcelCoding /docs/python/ @cryptic-game/text @cryptic-game/head-of-python-backend @cryptic-game/head-assistant-of-python-backend @Defelo /docs/java/ @cryptic-game/text @cryptic-game/head-of-java-backend @cryptic-game/head-assistant-of-java-backend From 2560f4ba6c3c05552d958ed564dd90fbc3bc324c Mon Sep 17 00:00:00 2001 From: Jannik Emmerich Date: Sun, 13 Jun 2021 12:26:22 +0200 Subject: [PATCH 3/6] Update CODEOWNERS --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index fbf369c..c850b13 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,4 @@ * @JannikEmmerich @MarcelCoding -*.md @cryptic-game/text @MarcelCoding +*.md @cryptic-game/text @JannikEmmerich @MarcelCoding /docs/python/ @cryptic-game/text @cryptic-game/head-of-python-backend @cryptic-game/head-assistant-of-python-backend @Defelo /docs/java/ @cryptic-game/text @cryptic-game/head-of-java-backend @cryptic-game/head-assistant-of-java-backend From 72e26c8fc1dc7139269917d62d162ce143bed89a Mon Sep 17 00:00:00 2001 From: Marcel <34819524+MarcelCoding@users.noreply.github.com> Date: Sun, 13 Jun 2021 13:39:42 +0200 Subject: [PATCH 4/6] Update mkdocs.yml --- mkdocs.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index ca4276e..ad0056a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,12 +1,15 @@ site_name: Cryptic Documentation -repo_url: https://github.com/cryptic-game/docs repo_name: cryptic-game/docs +repo_url: https://github.com/cryptic-game/docs edit_uri: edit/main/docs/ theme: name: material # logo: assets/logo.svg favicon: assets/favicon.ico + font: + text: Public Sans + code: Roboto Mono palette: primary: light green accent: deep orange From d44b0468f1429044069172f4c6d1d9bcb4609232 Mon Sep 17 00:00:00 2001 From: Jannik Emmerich Date: Sun, 13 Jun 2021 14:05:31 +0200 Subject: [PATCH 5/6] Update mkdocs.yml --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index ad0056a..be11a93 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ site_name: Cryptic Documentation repo_name: cryptic-game/docs repo_url: https://github.com/cryptic-game/docs -edit_uri: edit/main/docs/ +edit_uri: edit/master/docs/ theme: name: material From cc1f8e887030e08e8828ba7a9180403d10592044 Mon Sep 17 00:00:00 2001 From: Marcel <34819524+MarcelCoding@users.noreply.github.com> Date: Sun, 13 Jun 2021 14:23:12 +0200 Subject: [PATCH 6/6] Added docs for public instances (#2) --- docs/deployment/index.md | 1 - docs/deployment/public-instances.md | 26 ++++++++++++++++++++++++++ mkdocs.yml | 2 +- 3 files changed, 27 insertions(+), 2 deletions(-) delete mode 100644 docs/deployment/index.md create mode 100644 docs/deployment/public-instances.md diff --git a/docs/deployment/index.md b/docs/deployment/index.md deleted file mode 100644 index bad5562..0000000 --- a/docs/deployment/index.md +++ /dev/null @@ -1 +0,0 @@ -# Getting Started diff --git a/docs/deployment/public-instances.md b/docs/deployment/public-instances.md new file mode 100644 index 0000000..2353a18 --- /dev/null +++ b/docs/deployment/public-instances.md @@ -0,0 +1,26 @@ +# Public Instances + +The team behind Cryptic is currently hosting two instances of Cryptic. + +## Production Instance + +The production instance is the instance where the actual game takes place. +This instance is always running the latest stable version. + +| Endpoint | Description | +|------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| [`https://play.cryptic-game.net`](https://play.cryptic-game.net) | The offical frontend. | +| `wss://server.cryptic-game.net/ws` | The actual api for the frontend. ([Learn more](../protocol/websocket.md)) | +| [`https://server.cryptic-game.net/api`](https://server.cryptic-game.net/api) | The rest api for the game. (e.g. authentication, statistics, [Learn more](../protocol/rest.md)) | + +## Staging Instance + +The staging instance is the instance on which the game is tested. It is not recommended to play seriously on this instance. +The database is reset periodically and money and other resources are freely distributed by developers to test new features. +This instance is always running the current latest **unstable** version. + +| Endpoint | Description | +|----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| [`https://play.staging.cryptic-game.net`](https://play.staging.cryptic-game.net) | The offical frontend. | +| `wss://server.staging.cryptic-game.net/ws` | The actual api for the frontend. ([Learn more](../protocol/websocket.md)) | +| [`https://server.staging.cryptic-game.net/api`](https://server.staging.cryptic-game.net/api) | The rest api for the game. (e.g. authentication, statistics [Learn more](../protocol/rest.md)) | diff --git a/mkdocs.yml b/mkdocs.yml index be11a93..e9a0b90 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,7 +33,7 @@ plugins: - git-revision-date - redirects: redirect_maps: - 'index.md': 'infrastructure/index.md' + 'index.md': 'deployment/public-instances.md' - minify: minify_html: true minify_js: true