Add deprecation notice (#310)

Add deprecation notices to all pages Add deprecation notice in main repo readme
R2Northstar · Oct 4, 2024 · cafd307 · cafd307
1 parent 6d0ea06
commit cafd307
Show file tree

Hide file tree

Showing 58 changed files with 522 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,12 @@
 # Northstar Wiki Repo
 
+> [!WARNING]  
+> The GitBook based NorthstarWiki has been deprecated in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+> 
+> Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+> 
+> The source for the NorthstarDocs can be found here: [https://github.com/R2Northstar/NorthstarDocs](https://github.com/R2Northstar/NorthstarDocs)
+
 This repo contains documentation around the [Northstar mod](https://github.com/R2Northstar), a Titanfall 2 mod to join and host custom community servers.
 
 The `docs/` directory contains the content synchronised to the [GitBook Wiki page](https://r2northstar.gitbook.io/).

diff --git a/docs/README.md b/docs/README.md
@@ -4,6 +4,15 @@ description: A Titanfall|2 mod to join and host custom servers.
 cover: images/northstarbanner.png
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/./
+
+{% endhint %}
+
 # Welcome to Northstar
 
 {% embed url="https://www.youtube.com/watch?v=en06Y6CPMQg" %}

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -2,6 +2,15 @@
 description: Contribution guidelines
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/contributing
+
+{% endhint %}
+
 # Contributing
 
 ## Creating an issue <a href="#contributing" id="contributing"></a>

diff --git a/docs/development/README.md b/docs/development/README.md
@@ -4,6 +4,15 @@ description: >-
   it.
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/
+
+{% endhint %}
+
 # Development
 
 Check the subpages on the sidebar for various aspects of Northstar development.

diff --git a/docs/development/contributing-code-to-northstar.md b/docs/development/contributing-code-to-northstar.md
@@ -2,6 +2,15 @@
 description: Useful information when contributing to Northstar
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/contributing-code-to-northstar
+
+{% endhint %}
+
 # Contributing code to Northstar
 
 {% hint style="info" %}

diff --git a/docs/development/debugging/README.md b/docs/development/debugging/README.md
@@ -1,5 +1,14 @@
 # Debugging
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/debugging/
+
+{% endhint %}
+
 {% hint style="warning" %}
 Debugging Northstar is only recommended to experienced developers.
 If you need help figuring out an issue feel free to visit the Northstar Discord.

diff --git a/docs/development/debugging/visualstudio.md b/docs/development/debugging/visualstudio.md
@@ -1,5 +1,14 @@
 # Visual Studio
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/debugging/visualstudio
+
+{% endhint %}
+
 Northstar is easiest to debug through Visual Studio due to its cmake support.
 
 

diff --git a/docs/development/debugging/x64dbg.md b/docs/development/debugging/x64dbg.md
@@ -1,5 +1,14 @@
 # x64dbg
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/debugging/x64dbg
+
+{% endhint %}
+
 {% hint style="warning" %}
 If you are not experienced with x64dbg it its recommended to use [Visual Studio](visualstudio.md).
 {% endhint %}

diff --git a/docs/development/northstarmasterserver/README.md b/docs/development/northstarmasterserver/README.md
@@ -1,5 +1,14 @@
 # NorthstarMasterServer
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/northstarmasterserver/
+
+{% endhint %}
+
 {% hint style="warning" %}
 The old NodeJS master server has been replaced in favour of the Go rewrite called Atlas.
 {% endhint %}

diff --git a/docs/development/northstarmasterserver/deploy.md b/docs/development/northstarmasterserver/deploy.md
@@ -1,5 +1,14 @@
 # Deploy
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/northstarmasterserver/deploy
+
+{% endhint %}
+
 ## Development
 
 A Development Master Server uses http requests, it should be used for development purposes on your local machine.

diff --git a/docs/development/releases.md b/docs/development/releases.md
@@ -4,6 +4,15 @@ description: >-
   new releases
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/releases
+
+{% endhint %}
+
 # Releases
 
 {% hint style="info" %}

diff --git a/docs/development/repositories/README.md b/docs/development/repositories/README.md
@@ -1,5 +1,14 @@
 # Repositories
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/
+
+{% endhint %}
+
 Northstar is split over multiple git repositories that fulfill different functions.
 
 * [Atlas](https://github.com/R2Northstar/Atlas):\

diff --git a/docs/development/repositories/atlas.md b/docs/development/repositories/atlas.md
@@ -2,6 +2,15 @@
 description: A new Northstar master server written in Go
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/atlas
+
+{% endhint %}
+
 # Atlas
 
 TODO
diff --git a/docs/development/repositories/northstarlauncher.md b/docs/development/repositories/northstarlauncher.md
@@ -1,5 +1,14 @@
 # NorthstarLauncher
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/northstarlauncher
+
+{% endhint %}
+
 ### Setup
 
 Build instructions for the launcher can be found here:

diff --git a/docs/development/repositories/northstarmods.md b/docs/development/repositories/northstarmods.md
@@ -2,6 +2,15 @@
 description: Core squirrel mods
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/repositories/northstarmods
+
+{% endhint %}
+
 # NorthstarMods
 
 TODO

diff --git a/docs/development/reviewing.md b/docs/development/reviewing.md
@@ -5,6 +5,15 @@ description: >-
   review in general.
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/reviewing
+
+{% endhint %}
+
 # Reviewing
 
 For new pull requests to be merged into any of the Northstar repos, they need to reviewed to reduce the changes of introducing bugs as well as ensuring that in case of a feature it's something the community actually wants.

diff --git a/docs/development/testing.md b/docs/development/testing.md
@@ -4,6 +4,15 @@ description: >-
   maintainers
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/development/testing
+
+{% endhint %}
+
 # Testing
 
 {% hint style="info" %}

diff --git a/docs/faq.md b/docs/faq.md
@@ -2,6 +2,15 @@
 description: Frequently asked questions
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/faq
+
+{% endhint %}
+
 # FAQ
 
 ## **If you have any issues please go to [the troubleshooting page.](installing-northstar/troubleshooting.md)**

diff --git a/docs/hosting-a-server-with-northstar/basic-listen-server.md b/docs/hosting-a-server-with-northstar/basic-listen-server.md
@@ -1,5 +1,14 @@
 # Hosting a Basic Listen Server
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/basic-listen-server
+
+{% endhint %}
+
 ## Requirements
 
 Make sure to check that your server is reachable as [described here](./getting-started.md)

diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/README.md b/docs/hosting-a-server-with-northstar/dedicated-server/README.md
@@ -1,5 +1,14 @@
 # Hosting a Dedicated Server
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/dedicated-server/
+
+{% endhint %}
+
 ## Hosting a Dedicated Server
 
 ### Setup
@@ -18,4 +27,4 @@ Regarding RAM usage, dedicated servers also use significant amounts of RAM at th
 
 See [troubleshoot](../troubleshooting.md)
 
-For all settings see [Server settings](../server-settings/README.md)
+For all settings see [Server settings](../server-settings/README.md)
diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md
@@ -2,6 +2,15 @@
 description: Tweaks and tricks to improve both your experience in hosting and others' in playing on your server
 ---
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/dedicated-server/best-practices
+
+{% endhint %}
+
 # Best practices
 
 {% hint style="info" %}

diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md b/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md
@@ -1,5 +1,14 @@
 # Hosting on Linux
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux
+
+{% endhint %}
+
 {% hint style="info" %}
 This page is currently work-in-progress.
 {% endhint %}

diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-windows.md b/docs/hosting-a-server-with-northstar/dedicated-server/hosting-on-windows.md
@@ -1,5 +1,14 @@
 # Hosting on Windows
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/dedicated-server/hosting-on-windows
+
+{% endhint %}
+
 ## Minimum requirements
 
 The current minimum requirements are as follows:

diff --git a/docs/hosting-a-server-with-northstar/getting-started.md b/docs/hosting-a-server-with-northstar/getting-started.md
@@ -1,5 +1,14 @@
 # Getting started
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/getting-started
+
+{% endhint %}
+
 **TL;DR:** Port forward `37015` (UDP), and no [CGNAT](getting-started.md#cgnat)
 
 Make sure you already installed Northstar [as described here](../installing-northstar/basic-setup.md).

diff --git a/docs/hosting-a-server-with-northstar/local-only-server.md b/docs/hosting-a-server-with-northstar/local-only-server.md
@@ -1,5 +1,14 @@
 # Hosting a Local-Only Server
 
+{% hint style="warning" %}
+The GitBook based NorthstarWiki has been replaced in favour of the [NorthstarDocs](https://docs.northstar.tf/) where this wiki has been integrated.
+
+Check it out here: [https://docs.northstar.tf/Wiki/](https://docs.northstar.tf/Wiki/)
+
+The same page on the new wiki should be located here: https://docs.northstar.tf/Wiki/hosting-a-server-with-northstar/local-only-server
+
+{% endhint %}
+
 If you just want to host server (listen or dedicated) for people in your local network (as in computer network, not the in-game Networks system), you can simply not enable port-forwarding and set `ns_auth_allow_insecure` to `1` in the `autoexec_ns_server.cfg`.
 
 This way players can connect to your server directly by using the `connect` command with the local IP of your server, e.g. `connect 192.168.420.500` (replace with actual local IP of your server).