From 23849da8988eb016c769efa78f1323242ac34a97 Mon Sep 17 00:00:00 2001 From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> Date: Wed, 11 Oct 2023 17:44:22 +0200 Subject: [PATCH] Adjust development section folder structure (#235) * Adjust development section folder structure The structure of development related pages is a leftover from when modding and development were combined in a single folder. Modding related content has since long moved to ModdingDocs. As such we should update the folder structure accordingly * Update broken links --- docs/SUMMARY.md | 22 +++++++++---------- docs/contributing.md | 2 +- .../development/README.md | 0 .../contributing-code-to-northstar.md | 0 .../development/northstarlauncher.md | 0 .../northstarmasterserver/README.md | 2 +- .../northstarmasterserver/deploy.md | 0 .../development/releases.md | 0 .../development/repositories/README.md | 0 .../development/repositories/atlas.md | 0 .../development/repositories/northstarmods.md | 0 .../development/reviewing.md | 10 ++++----- .../testing.md | 2 +- 13 files changed, 19 insertions(+), 19 deletions(-) rename docs/{modding-and-development => }/development/README.md (100%) rename docs/{modding-and-development => }/development/contributing-code-to-northstar.md (100%) rename docs/{modding-and-development => }/development/northstarlauncher.md (100%) rename docs/{modding-and-development => }/development/northstarmasterserver/README.md (55%) rename docs/{modding-and-development => }/development/northstarmasterserver/deploy.md (100%) rename docs/{modding-and-development => }/development/releases.md (100%) rename docs/{modding-and-development => }/development/repositories/README.md (100%) rename docs/{modding-and-development => }/development/repositories/atlas.md (100%) rename docs/{modding-and-development => }/development/repositories/northstarmods.md (100%) rename docs/{modding-and-development => }/development/reviewing.md (94%) rename docs/{modding-and-development => development}/testing.md (98%) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index f5bcd4f1..da572769 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -47,17 +47,17 @@ ## Modding and Development * [Modding](modding/README.md) -* [Development](modding-and-development/development/README.md) - * [Repositories](modding-and-development/development/repositories/README.md) - * [Atlas](modding-and-development/development/repositories/atlas.md) - * [NorthstarMods](modding-and-development/development/repositories/northstarmods.md) - * [NorthstarLauncher](modding-and-development/development/northstarlauncher.md) - * [NorthstarMasterServer (old)](modding-and-development/development/northstarmasterserver/README.md) - * [Deploy](modding-and-development/development/northstarmasterserver/deploy.md) - * [Contributing code to Northstar](modding-and-development/development/contributing-code-to-northstar.md) - * [Testing](modding-and-development/testing.md) - * [Reviewing](modding-and-development/development/reviewing.md) - * [Releases](modding-and-development/development/releases.md) +* [Development](development/README.md) + * [Repositories](development/repositories/README.md) + * [Atlas](development/repositories/atlas.md) + * [NorthstarMods](development/repositories/northstarmods.md) + * [NorthstarLauncher](development/northstarlauncher.md) + * [NorthstarMasterServer (old)](development/northstarmasterserver/README.md) + * [Deploy](development/northstarmasterserver/deploy.md) + * [Contributing code to Northstar](development/contributing-code-to-northstar.md) + * [Testing](development/testing.md) + * [Reviewing](development/reviewing.md) + * [Releases](development/releases.md) ## Other diff --git a/docs/contributing.md b/docs/contributing.md index b953b61e..083cae5b 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -12,4 +12,4 @@ Read [CONTRIBUTING.md](https://github.com/R2Northstar/Northstar/blob/main/CONTRI Please remember that issues created in the Northstar repositories should be related to the mod, avoid creating issues asking for tech support or problems unrelated to the project. {% endhint %} -Check the [Development](modding-and-development/development/README.md) section if you are unsure of where to open a ticket. +Check the [Development](development/README.md) section if you are unsure of where to open a ticket. diff --git a/docs/modding-and-development/development/README.md b/docs/development/README.md similarity index 100% rename from docs/modding-and-development/development/README.md rename to docs/development/README.md diff --git a/docs/modding-and-development/development/contributing-code-to-northstar.md b/docs/development/contributing-code-to-northstar.md similarity index 100% rename from docs/modding-and-development/development/contributing-code-to-northstar.md rename to docs/development/contributing-code-to-northstar.md diff --git a/docs/modding-and-development/development/northstarlauncher.md b/docs/development/northstarlauncher.md similarity index 100% rename from docs/modding-and-development/development/northstarlauncher.md rename to docs/development/northstarlauncher.md diff --git a/docs/modding-and-development/development/northstarmasterserver/README.md b/docs/development/northstarmasterserver/README.md similarity index 55% rename from docs/modding-and-development/development/northstarmasterserver/README.md rename to docs/development/northstarmasterserver/README.md index e40cef53..d6c94b5d 100644 --- a/docs/modding-and-development/development/northstarmasterserver/README.md +++ b/docs/development/northstarmasterserver/README.md @@ -8,7 +8,7 @@ The old NodeJS master server has been replaced in favour of the Go rewrite calle The master server is responsible for centralizing game servers created by players, it also verifies that connecting players own an Origin account with Titanfall 2. -There's no need to host your own master server to play games with other people, you can use [direct connect](../../../using-northstar/direct-connect.md) or just setup a [normal server](../../../hosting-a-server-with-northstar/basic-listen-server.md) that announces itself to `northstar.tf`. This tutorial is aimed for those who want to contribute improvements to the code or test their own changes to the project. +There's no need to host your own master server to play games with other people, you can use [direct connect](../../using-northstar/direct-connect.md) or just setup a [normal server](../../hosting-a-server-with-northstar/basic-listen-server.md) that announces itself to `northstar.tf`. This tutorial is aimed for those who want to contribute improvements to the code or test their own changes to the project. ## Contents diff --git a/docs/modding-and-development/development/northstarmasterserver/deploy.md b/docs/development/northstarmasterserver/deploy.md similarity index 100% rename from docs/modding-and-development/development/northstarmasterserver/deploy.md rename to docs/development/northstarmasterserver/deploy.md diff --git a/docs/modding-and-development/development/releases.md b/docs/development/releases.md similarity index 100% rename from docs/modding-and-development/development/releases.md rename to docs/development/releases.md diff --git a/docs/modding-and-development/development/repositories/README.md b/docs/development/repositories/README.md similarity index 100% rename from docs/modding-and-development/development/repositories/README.md rename to docs/development/repositories/README.md diff --git a/docs/modding-and-development/development/repositories/atlas.md b/docs/development/repositories/atlas.md similarity index 100% rename from docs/modding-and-development/development/repositories/atlas.md rename to docs/development/repositories/atlas.md diff --git a/docs/modding-and-development/development/repositories/northstarmods.md b/docs/development/repositories/northstarmods.md similarity index 100% rename from docs/modding-and-development/development/repositories/northstarmods.md rename to docs/development/repositories/northstarmods.md diff --git a/docs/modding-and-development/development/reviewing.md b/docs/development/reviewing.md similarity index 94% rename from docs/modding-and-development/development/reviewing.md rename to docs/development/reviewing.md index 920df356..a9d89341 100644 --- a/docs/modding-and-development/development/reviewing.md +++ b/docs/development/reviewing.md @@ -19,15 +19,15 @@ It's not necessary to do both when reviewing as long as you mention what you did For code review head to the _"Files changed"_ section of the PR. -![](../../.gitbook/assets/review1.png) +![](../.gitbook/assets/review1.png) From there you can select the line(s) you want to leave a comment on. -![](../../.gitbook/assets/review2.PNG) +![](../.gitbook/assets/review2.PNG) Type in your comment and click on _"Start a review"_. -![](../../.gitbook/assets/review3.png) +![](../.gitbook/assets/review3.png) Note that this will **NOT** post your comment immediately! Add any remaining comments to other lines of code, then head to the _Finishing up_ section of this wiki page to see how to post your code review. @@ -38,7 +38,7 @@ Note that this will **NOT** post your comment immediately! Add any remaining com For testing a PR, refer to the following page {% content-ref url="../testing.md" %} -[testing.md](../testing.md) +[testing.md](./testing.md) {% endcontent-ref %} The TL;DR is to test the aspect that has been changed. @@ -47,7 +47,7 @@ The TL;DR is to test the aspect that has been changed. After you performed the testing and/or code review leave a final comment by clicking on _"Finish your review"_ on the top right of the _"Files changed"_ page of the PR. -![](../../.gitbook/assets/review4.png) +![](../.gitbook/assets/review4.png) In your final comment make sure to mention what you did, e.g. which aspects of the change you tested for or what you considered during code review (formatting, edge cases, ...). The more detailed this part is the easier it is for other reviewers to tell which aspects they can skip during reviewing to speed up the process. diff --git a/docs/modding-and-development/testing.md b/docs/development/testing.md similarity index 98% rename from docs/modding-and-development/testing.md rename to docs/development/testing.md index 2be33c2d..8ba01ff9 100644 --- a/docs/modding-and-development/testing.md +++ b/docs/development/testing.md @@ -55,7 +55,7 @@ Before starting, make sure you have a **working and up-to-date Northstar install ![rcon4](https://user-images.githubusercontent.com/40122905/179727511-877641f8-e5fc-4a34-bcf1-29bafefc1ad2.png) 5. Once downloaded, open the zip and copy `Northstar.dll` and `NorthstarLauncher.exe` to your Titanfall2 folder, overwriting the existing DLL and EXE in there. -Alternatively, compiling the PR'd code from source is also an option. For this, refer to [northstarlauncher.md](development/northstarlauncher.md "mention") +Alternatively, compiling the PR'd code from source is also an option. For this, refer to [northstarlauncher.md](northstarlauncher.md "mention") #### NorthstarMods