From 027605225a7985c768879035c14946729888a88b Mon Sep 17 00:00:00 2001 From: GeckoEidechse Date: Thu, 16 Jun 2022 15:53:22 +0000 Subject: GitBook: [#48] Move repository descriptions to designated page --- docs/SUMMARY.md | 2 +- docs/modding-and-development/development/README.md | 26 +++--------------- .../development/repositories/README.md | 23 +++++++++++++++- .../modding-and-development/development/testing.md | 31 ---------------------- docs/modding-and-development/testing.md | 30 +++++++++++++++++++++ 5 files changed, 57 insertions(+), 55 deletions(-) delete mode 100644 docs/modding-and-development/development/testing.md create mode 100644 docs/modding-and-development/testing.md (limited to 'docs') diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index a07635f..415acba 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -40,7 +40,7 @@ * [NorthstarLauncher](modding-and-development/development/northstarlauncher.md) * [NorthstarMasterServer](modding-and-development/development/northstarmasterserver/README.md) * [Deploy](modding-and-development/development/northstarmasterserver/deploy.md) - * [Testing](modding-and-development/development/testing.md) + * [Testing](modding-and-development/testing.md) ## Other diff --git a/docs/modding-and-development/development/README.md b/docs/modding-and-development/development/README.md index 7d43efd..56acd02 100644 --- a/docs/modding-and-development/development/README.md +++ b/docs/modding-and-development/development/README.md @@ -6,26 +6,8 @@ description: >- # Development -## Repositories - -Northstar is split over multiple git repositories that fulfill different functions. - -* [Northstar](https://github.com/R2Northstar/Northstar):\ - Contains compiled and packaged releases -* [NorthstarLauncher](https://github.com/R2Northstar/NorthstarLauncher):\ - Contains the source for the launcher used to modify the Titanfall|2 install to allow mods to be loaded. -* [NorthstarMods](https://github.com/R2Northstar/NorthstarMods):\ - Contains the standard mods shipped with Northstar to allow joining and hosting custom servers. -* [NorthstarMasterServer](https://github.com/R2Northstar/NorthstarMasterServer):\ - Contains the source for the master server used to authenticate clients, display the server browser list, and connect clients to community hosted servers. -* [NorthstarDiscordRPC](https://github.com/R2Northstar/NorthstarDiscordRPC):\ - Contains plugin to integrate Northstar with Discord's SDK to enable rich presence. -* [NorthstarNavs](https://github.com/R2Northstar/NorthstarNavs):\ - Contains custom navmesh files to use with TItanfall 2 AI -* [NorthstarStubs](https://github.com/R2Northstar/NorthstarStubs):\ - Contains D3D11 and GFSDK stubs for the Northstar dedicated server. -* [NorthstarWiki](https://github.com/R2Northstar/NorthstarWiki):\ - The repository for this wiki. -* [ModdingDocs](https://github.com/R2Northstar/ModdingDocs):\ - Contains guides and tutorials on how to mod using Northstar +Check the following page for information about different code repositories Northstar uses +{% content-ref url="repositories/" %} +[repositories](repositories/) +{% endcontent-ref %} diff --git a/docs/modding-and-development/development/repositories/README.md b/docs/modding-and-development/development/repositories/README.md index d459d3b..db59a0b 100644 --- a/docs/modding-and-development/development/repositories/README.md +++ b/docs/modding-and-development/development/repositories/README.md @@ -1,3 +1,24 @@ # Repositories -The Northstar codebase stretches over multiple repositories, with different repos containing code for different aspects of Northstar. Check sub-pages for a description of some of them. +Northstar is split over multiple git repositories that fulfill different functions. + +* [Northstar](https://github.com/R2Northstar/Northstar):\ + Contains compiled and packaged releases +* [NorthstarLauncher](https://github.com/R2Northstar/NorthstarLauncher):\ + Contains the source for the launcher used to modify the Titanfall|2 install to allow mods to be loaded. +* [NorthstarMods](https://github.com/R2Northstar/NorthstarMods):\ + Contains the standard mods shipped with Northstar to allow joining and hosting custom servers. +* [NorthstarMasterServer](https://github.com/R2Northstar/NorthstarMasterServer):\ + Contains the source for the master server used to authenticate clients, display the server browser list, and connect clients to community hosted servers. +* [NorthstarDiscordRPC](https://github.com/R2Northstar/NorthstarDiscordRPC):\ + Contains plugin to integrate Northstar with Discord's SDK to enable rich presence. +* [NorthstarNavs](https://github.com/R2Northstar/NorthstarNavs):\ + Contains custom navmesh files to use with TItanfall 2 AI +* [NorthstarStubs](https://github.com/R2Northstar/NorthstarStubs):\ + Contains D3D11 and GFSDK stubs for the Northstar dedicated server. +* [NorthstarWiki](https://github.com/R2Northstar/NorthstarWiki):\ + The repository for this wiki. +* [ModdingDocs](https://github.com/R2Northstar/ModdingDocs):\ + Contains guides and tutorials on how to mod using Northstar + +Check the subpages of this wiki for additional information about some of these repositories. diff --git a/docs/modding-and-development/development/testing.md b/docs/modding-and-development/development/testing.md deleted file mode 100644 index 6c237dd..0000000 --- a/docs/modding-and-development/development/testing.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -description: >- - Instructions regarding testing new features, directed at both developers and - maintainers ---- - -# Testing - -{% hint style="info" %} -This section is very much still WIP. Feel free to help expand it. -{% endhint %} - -## Developers & Contributors - -This section applies to you if you're opening a pull request to any of the Northstar repos. - -Whatever your change includes, whether a bug fix or a new feature make sure to test it appropriately. - -This means if your change is a bug fix, it's recommend you first make sure you can reproduce the bug. Then after making the necessary changes to fix it, test it using the same method you used to originally confirm the bug. \ -When you're opening a pull request, make sure to mention how to reproduce the bug, so that reviewers can confirm that your chance indeed fixed the issue. - -If your change is a new feature, make sure to test both that the newly added functionality performs as expected, as well as ensuring that it doesn't introduce any form of regression bugs. This means, testing anything that might be affected by your new feature. - - -## Maintainers - -This section applies to you if you're someone who's able to merge PRs in any of the repos of the Northstar GitHub org as well as when simplying performing reviews, even without being able to actually merge a PR. - -When reviewing pull requests on GitHub, make sure to checkout the changes made by a PR locally and test it there. In particular, test the parts of the code that are touched by a PR. - -After testing, make sure to mention the steps tested in your review. diff --git a/docs/modding-and-development/testing.md b/docs/modding-and-development/testing.md new file mode 100644 index 0000000..94aa9be --- /dev/null +++ b/docs/modding-and-development/testing.md @@ -0,0 +1,30 @@ +--- +description: >- + Instructions regarding testing new features, directed at both developers and + maintainers +--- + +# Testing + +{% hint style="info" %} +This section is very much still WIP. Feel free to help expand it. +{% endhint %} + +## Developers & Contributors + +This section applies to you if you're opening a pull request to any of the Northstar repos. + +Whatever your change includes, whether a bug fix or a new feature make sure to test it appropriately. + +This means if your change is a bug fix, it's recommend you first make sure you can reproduce the bug. Then after making the necessary changes to fix it, test it using the same method you used to originally confirm the bug.\ +When you're opening a pull request, make sure to mention how to reproduce the bug, so that reviewers can confirm that your chance indeed fixed the issue. + +If your change is a new feature, make sure to test both that the newly added functionality performs as expected, as well as ensuring that it doesn't introduce any form of regression bugs. This means, testing anything that might be affected by your new feature. + +## Maintainers + +This section applies to you if you're someone who's able to merge PRs in any of the repos of the Northstar GitHub org as well as when simplying performing reviews, even without being able to actually merge a PR. + +When reviewing pull requests on GitHub, make sure to checkout the changes made by a PR locally and test it there. In particular, test the parts of the code that are touched by a PR. + +After testing, make sure to mention the steps tested in your review. -- cgit v1.2.3