From f66c60da84b2edaf968bedc5c8268e185eabe316 Mon Sep 17 00:00:00 2001 From: patrickvuleta <161555144+patrickvuleta@users.noreply.github.com> Date: Wed, 26 Jun 2024 16:56:34 +1000 Subject: [PATCH 1/2] update file structure --- public/Game Management/Metrics/Dashboards.md | 14 -- public/Game Management/Metrics/Export.md | 12 - public/Game Management/Metrics/Overview.md | 12 - public/Game Management/Metrics/Trending.md | 12 - .../Game Management/Metrics/_category_.json | 3 - public/Game Management/Metrics/ccu.md | 12 - public/Integration/Embeddable Hub/Overview.md | 12 - public/Integration/Embeddable Hub/Setup.md | 12 - .../Embeddable Hub/_category_.json | 3 - .../Integration/Overview/Console Platforms.md | 35 --- public/Integration/Overview/_category_.json | 3 - public/Integration/Overview/single sign-on.md | 22 -- public/Integration/Unity/Overview.md | 2 +- ...{Getting Started.md => getting-started.md} | 0 .../console-sdks.md} | 4 +- .../GDK.md => console-platforms/gdk.md} | 2 +- .../console-support/nintendo_verification.png | Bin .../images/console-support/psn_auth_web.png | Bin .../images/console-support/report-dialog.png | Bin .../images/console-support/skaterxl_ui.png | Bin .../images/console-support/snowrunner_ui.jpg | Bin .../console-support/submission_flow.png | Bin .../images/console-support/xbox_auth_web.png | Bin .../overview.md} | 2 +- .../PS4.md => console-platforms/ps4.md} | 2 +- .../Switch.md => console-platforms/switch.md} | 2 +- .../dependencies/dependency_management.md} | 2 +- .../images/game-dependency-settings.png | Bin .../images/ugc-dependency-settings.png | Bin .../moderation}/_category_.json | 0 .../moderation/automated-scanning.md} | 2 +- .../moderation/community-reports.md} | 2 +- .../moderation}/images/curation-settings.png | Bin .../moderation}/images/deleted-options.png | Bin .../moderation}/images/edit-ugc.png | Bin .../moderation}/images/file-scanning.png | Bin .../images/manage-permissions-popup.png | Bin .../moderation}/images/manage-permissions.png | Bin .../moderation}/images/media-scanning.png | Bin .../moderation}/images/moderation-queue.png | Bin .../moderation}/images/moderation-tabs.png | Bin .../moderation}/images/moderation.png | Bin .../moderation}/images/pending-approval.png | Bin .../moderation}/images/pending-files.png | Bin .../images/platform-moderation.png | Bin .../moderation}/images/regex.png | Bin .../moderation}/images/report.png | Bin .../moderation}/images/reported-mods.jpeg | Bin .../moderation}/images/request-details.png | Bin .../moderation}/images/request-history.png | Bin .../moderation}/images/restricted-users.png | Bin .../moderation}/images/review-files.png | Bin .../moderation}/images/rules-deny.png | Bin .../moderation}/images/rules-engine-ui.png | Bin .../moderation}/images/rules-flow.png | Bin .../moderation}/images/text-scanning.png | Bin .../moderation}/images/webhook-details.png | Bin .../moderation}/images/webhook-history.png | Bin .../moderation/manual-curation.md} | 2 +- .../moderation/moderation.md} | 6 +- .../moderation}/rules-engine-examples.md | 0 .../moderation}/rules-engine-monitoring.md | 0 .../moderation}/rules-engine-setup.md | 0 .../moderation}/rules-engine-webhooks.md | 0 .../moderation/rules_engine.md} | 2 +- .../modio/{Overview.md => getting-started.md} | 0 ...ching Your Game.md => launch-your-game.md} | 0 .../{premium-ugc.md => premium-features.md} | 0 ... User Consent.md => terms-user-consent.md} | 0 .../error-codes.md} | 0 .../rate-limiting.md} | 2 +- .../Key Contacts.md => support/contacts.md} | 0 .../knowledge-base.md} | 2 +- .../Searching.md => support/search.md} | 2 +- .../authentication/{openid.mdx => openid.md} | 0 .../{overview.mdx => overview.md} | 0 public/web/authentication/{s2s.mdx => s2s.md} | 0 ...e-studio-sso.mdx => website-studio-sso.md} | 0 ...server.mdx => modio-as-purchase-server.md} | 0 public/web/iap/{overview.mdx => overview.md} | 0 ...erver.mdx => studio-as-purchase-server.md} | 0 sidebars.js | 233 ++++++++++++++++++ 82 files changed, 251 insertions(+), 170 deletions(-) delete mode 100755 public/Game Management/Metrics/Dashboards.md delete mode 100755 public/Game Management/Metrics/Export.md delete mode 100755 public/Game Management/Metrics/Overview.md delete mode 100755 public/Game Management/Metrics/Trending.md delete mode 100644 public/Game Management/Metrics/_category_.json delete mode 100755 public/Game Management/Metrics/ccu.md delete mode 100644 public/Integration/Embeddable Hub/Overview.md delete mode 100644 public/Integration/Embeddable Hub/Setup.md delete mode 100644 public/Integration/Embeddable Hub/_category_.json delete mode 100644 public/Integration/Overview/Console Platforms.md delete mode 100644 public/Integration/Overview/_category_.json delete mode 100644 public/Integration/Overview/single sign-on.md rename public/Integration/Unity/{Getting Started.md => getting-started.md} (100%) rename public/{Console Platforms/Further Reading.md => console-platforms/console-sdks.md} (91%) rename public/{Console Platforms/GDK.md => console-platforms/gdk.md} (99%) rename public/{Console Platforms => console-platforms}/images/console-support/nintendo_verification.png (100%) rename public/{Console Platforms => console-platforms}/images/console-support/psn_auth_web.png (100%) rename public/{Console Platforms => console-platforms}/images/console-support/report-dialog.png (100%) rename public/{Console Platforms => console-platforms}/images/console-support/skaterxl_ui.png (100%) rename public/{Console Platforms => console-platforms}/images/console-support/snowrunner_ui.jpg (100%) rename public/{Console Platforms => console-platforms}/images/console-support/submission_flow.png (100%) rename public/{Console Platforms => console-platforms}/images/console-support/xbox_auth_web.png (100%) rename public/{Console Platforms/Overview.md => console-platforms/overview.md} (99%) rename public/{Console Platforms/PS4.md => console-platforms/ps4.md} (99%) rename public/{Console Platforms/Switch.md => console-platforms/switch.md} (99%) rename public/{Game Management/Dependencies/dependencies.md => game-management/dependencies/dependency_management.md} (99%) rename public/{Game Management/Dependencies => game-management/dependencies}/images/game-dependency-settings.png (100%) rename public/{Game Management/Dependencies => game-management/dependencies}/images/ugc-dependency-settings.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/_category_.json (100%) rename public/{Game Management/Moderation/Automated Scanning.md => game-management/moderation/automated-scanning.md} (98%) rename public/{Game Management/Moderation/Community Reports.md => game-management/moderation/community-reports.md} (99%) rename public/{Game Management/Moderation => game-management/moderation}/images/curation-settings.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/deleted-options.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/edit-ugc.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/file-scanning.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/manage-permissions-popup.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/manage-permissions.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/media-scanning.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/moderation-queue.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/moderation-tabs.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/moderation.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/pending-approval.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/pending-files.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/platform-moderation.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/regex.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/report.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/reported-mods.jpeg (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/request-details.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/request-history.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/restricted-users.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/review-files.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/rules-deny.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/rules-engine-ui.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/rules-flow.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/text-scanning.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/webhook-details.png (100%) rename public/{Game Management/Moderation => game-management/moderation}/images/webhook-history.png (100%) rename public/{Game Management/Moderation/Manual Curation.md => game-management/moderation/manual-curation.md} (99%) rename public/{Game Management/Moderation/Overview.md => game-management/moderation/moderation.md} (98%) rename public/{Game Management/Moderation => game-management/moderation}/rules-engine-examples.md (100%) rename public/{Game Management/Moderation => game-management/moderation}/rules-engine-monitoring.md (100%) rename public/{Game Management/Moderation => game-management/moderation}/rules-engine-setup.md (100%) rename public/{Game Management/Moderation => game-management/moderation}/rules-engine-webhooks.md (100%) rename public/{Game Management/Moderation/Rules Engine.md => game-management/moderation/rules_engine.md} (96%) rename public/modio/{Overview.md => getting-started.md} (100%) rename public/modio/{Launching Your Game.md => launch-your-game.md} (100%) rename public/modio/{premium-ugc.md => premium-features.md} (100%) rename public/modio/{Terms & User Consent.md => terms-user-consent.md} (100%) rename public/{REST API/Error Codes.md => rest-api/error-codes.md} (100%) rename public/{REST API/Rate Limiting.md => rest-api/rate-limiting.md} (93%) rename public/{Support/Key Contacts.md => support/contacts.md} (100%) rename public/{Support/Knowledge Base.md => support/knowledge-base.md} (89%) rename public/{Support/Searching.md => support/search.md} (91%) rename public/web/authentication/{openid.mdx => openid.md} (100%) rename public/web/authentication/{overview.mdx => overview.md} (100%) rename public/web/authentication/{s2s.mdx => s2s.md} (100%) rename public/web/authentication/{website-studio-sso.mdx => website-studio-sso.md} (100%) rename public/web/iap/{modio-as-purchase-server.mdx => modio-as-purchase-server.md} (100%) rename public/web/iap/{overview.mdx => overview.md} (100%) rename public/web/iap/{studio-as-purchase-server.mdx => studio-as-purchase-server.md} (100%) create mode 100644 sidebars.js diff --git a/public/Game Management/Metrics/Dashboards.md b/public/Game Management/Metrics/Dashboards.md deleted file mode 100755 index 2b070f6..0000000 --- a/public/Game Management/Metrics/Dashboards.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: metrics-dashboards -title: Dashboards -slug: /metrics/dashboards/ -sidebar_position: 1 ---- - -# Dashboards - -Access your game’s metrics through dashboards on UGC, Users and Health. - -We’re currently documenting these features, but please [reach out](mailto:developers@mod.io) if you have questions in the meantime. - -Test edit. \ No newline at end of file diff --git a/public/Game Management/Metrics/Export.md b/public/Game Management/Metrics/Export.md deleted file mode 100755 index a330ad3..0000000 --- a/public/Game Management/Metrics/Export.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: metrics-export -title: Data Export -slug: /metrics/export/ -sidebar_position: 4 ---- - -# Data Export - -You will soon be able to export your game’s data to CSV, or to an S3 bucket which you can then import into your own BI software. - -We’re currently documenting this feature, but please [reach out](mailto:developers@mod.io) if you have questions in the meantime. \ No newline at end of file diff --git a/public/Game Management/Metrics/Overview.md b/public/Game Management/Metrics/Overview.md deleted file mode 100755 index 403fb22..0000000 --- a/public/Game Management/Metrics/Overview.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: metrics -title: Overview -slug: /metrics/ -sidebar_position: 0 ---- - -# Overview - -The [mod.io](https://mod.io/) metrics system offers insights across many areas of UGC, including downloads, player activity and reports. - -We’re currently documenting these features, but please [reach out](mailto:developers@mod.io) if you have questions in the meantime. \ No newline at end of file diff --git a/public/Game Management/Metrics/Trending.md b/public/Game Management/Metrics/Trending.md deleted file mode 100755 index 907aa15..0000000 --- a/public/Game Management/Metrics/Trending.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: metrics-trending -title: Trending UGC & Creators -slug: /metrics/trending/ -sidebar_position: 2 ---- - -# Trending UGC & Creators - -You can view what is the trending UGC, and who are the trending creators from the metrics dashboards, including down to what is the most popular in the last week, so you can stay on top of trends as they emerge. - -We’re currently documenting this feature, but please [reach out](mailto:developers@mod.io) if you have questions in the meantime. \ No newline at end of file diff --git a/public/Game Management/Metrics/_category_.json b/public/Game Management/Metrics/_category_.json deleted file mode 100644 index 046edaa..0000000 --- a/public/Game Management/Metrics/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "position": 2 -} diff --git a/public/Game Management/Metrics/ccu.md b/public/Game Management/Metrics/ccu.md deleted file mode 100755 index ef64be2..0000000 --- a/public/Game Management/Metrics/ccu.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: metrics-ccu -title: Concurrent Users -slug: /metrics/ccu/ -sidebar_position: 3 ---- - -# Concurrent Users (CCUs) - -You will soon be able to view Concurrent Users from the metrics dashboards. These metrics will include the numbers of concurrent players and the particular UGC being played at any one time. - -We’re currently documenting this feature, but please [reach out](mailto:developers@mod.io) if you have questions in the meantime. \ No newline at end of file diff --git a/public/Integration/Embeddable Hub/Overview.md b/public/Integration/Embeddable Hub/Overview.md deleted file mode 100644 index 543a5f0..0000000 --- a/public/Integration/Embeddable Hub/Overview.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: hub -title: Overview -slug: /hub/ -sidebar_position: 0 ---- - -# Overview - -We offer an Embeddable Hub that lets your players download UGC from your website, from the [mod.io](https://mod.io/) servers. This can be customized to fit seamlessly into your existing branding and design. - -We’re currently documenting this feature, but please [reach out](mailto:developers@mod.io) if you have questions in the meantime. \ No newline at end of file diff --git a/public/Integration/Embeddable Hub/Setup.md b/public/Integration/Embeddable Hub/Setup.md deleted file mode 100644 index 94b36f3..0000000 --- a/public/Integration/Embeddable Hub/Setup.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: hub-setup -title: Setup -slug: /hub/setup/ -sidebar_position: 1 ---- - -# Setup - -Setting up the Embeddable Hub is easy. - -We’re currently documenting this process, but please [reach out](mailto:developers@mod.io) if you have questions in the meantime. \ No newline at end of file diff --git a/public/Integration/Embeddable Hub/_category_.json b/public/Integration/Embeddable Hub/_category_.json deleted file mode 100644 index 484e255..0000000 --- a/public/Integration/Embeddable Hub/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "position": 4 -} diff --git a/public/Integration/Overview/Console Platforms.md b/public/Integration/Overview/Console Platforms.md deleted file mode 100644 index fa6843c..0000000 --- a/public/Integration/Overview/Console Platforms.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: certification -title: Console Certification -slug: /certification/ -sidebar_position: 1 ---- - -# Console Certification -Passing the certification process to enable UGC on consoles largely consists of following requirements set by the platform owners. We recommend that you do this after you’ve already enabled UGC on PC to ensure you know how UGC will be offered in your game. - -## Contact your platform account manager -The first step is to send your platform account manager a document which explains how UGC will function in your game, and answers any questions they raise. This document should include: - -* storage systems and space required -* your moderation and reporting process -* how UGC is created (in-game or via 3rd party editing tools) -* how players engage with UGC (in-game and by subscribing via your mod hub website) -* how content delivery happens (using mod.io secured APIs) -* the type of UGC being shared (levels, skins, configs) -* whether the UGC execute scripts - - -## Typical requirements -Your account manager will provide you with the platform’s requirements. These typically include: - -* no scripts, or approved / sandboxed scripts only -* no network, filesystem access, or approved / sandboxed access only -* UGC should be stored in an appropriate location and not be mixed with, or overwrite game files -* if UGC has the potential to crash your game, users must be able to disable it on launch (or ideally, only initialize mods when playing with them) -* you must have a way for users to report mods, and a process for reported mods to be taken down -* allocate only a limited storage space for UGC installation users with parental controls that disable UGC cannot have access to UGC -* users must give consent before they access UGC -* if you know the user’s platform display name, you must show it alongside their content - -We built our Unreal Engine and Unity plugins with these requirements in mind, making certification easy to pass. Additionally, each platform has specific requirements. Note that some of this information is confidential and requires that you sign an NDA with the platform owner before we can provide access. diff --git a/public/Integration/Overview/_category_.json b/public/Integration/Overview/_category_.json deleted file mode 100644 index 3fca6fb..0000000 --- a/public/Integration/Overview/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "position": 0 -} diff --git a/public/Integration/Overview/single sign-on.md b/public/Integration/Overview/single sign-on.md deleted file mode 100644 index ff27e05..0000000 --- a/public/Integration/Overview/single sign-on.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: sso -title: Single Sign-On -slug: /sso/ -sidebar_position: 2 ---- - -# Single Sign-On - -Users must authenticate via single sign-on before they can download UGC in-game. You have two options: link [mod.io](https://mod.io/) to your user account system or use your authentication provider. - -## Linking to your user account system - -This involves linking a user’s [mod.io](https://mod.io/) account to your user account system using OAuth 2.0, and then using that link to make authenticated calls to the [mod.io](https://mod.io/) REST API. This is easy to implement, as it is similar to Twitch or Steam authentication. You will need a way to store and access the users mod.io token, to authenticate the user in-game and on the web. - -The downside to this option is that it makes it difficult to use the Embeddable Hub premium feature on your game’s website, as [mod.io](https://mod.io/) has no information on the user’s account. Moderation can also be more challenging, as users can change the [mod.io](https://mod.io/) account they link to your system to get around user bans. - -## Using your authentication provider - -[mod.io](https://mod.io/) supports any authentication provider using the industry standard protocols, OAuth 2.0 and OpenID Connect. We support all major platforms, including Steam, Xbox Live and PlayStation Network. - -To enable this, you will need to support OAuth 2.0 to authenticate on the web, and support OpenID Connect as an authentication provider. [mod.io](https://mod.io/) retrieves and stores user ids, and uses these credentials to create a [mod.io](https://mod.io/) account for them. This is more complex to implement, but creates less friction for the player, since they don’t need to make the [mod.io](https://mod.io/) account. Rather, this happens automatically in the game client. \ No newline at end of file diff --git a/public/Integration/Unity/Overview.md b/public/Integration/Unity/Overview.md index f453a76..5a95ec7 100755 --- a/public/Integration/Unity/Overview.md +++ b/public/Integration/Unity/Overview.md @@ -5,7 +5,7 @@ slug: /unity/ sidebar_position: 0 --- -# Overview +# mod.io Unity Plugin The [mod.io](https://mod.io/) Unity Engine plugin is the simplest and fastest way to integrate UGC into your Unity **2020.3+** game. It handles all of the common tasks, allowing game developers to quickly and easily implement a solution that enables players to access and discover user-generated content for their games. diff --git a/public/Integration/Unity/Getting Started.md b/public/Integration/Unity/getting-started.md similarity index 100% rename from public/Integration/Unity/Getting Started.md rename to public/Integration/Unity/getting-started.md diff --git a/public/Console Platforms/Further Reading.md b/public/console-platforms/console-sdks.md similarity index 91% rename from public/Console Platforms/Further Reading.md rename to public/console-platforms/console-sdks.md index 51e2fa7..57d554a 100644 --- a/public/Console Platforms/Further Reading.md +++ b/public/console-platforms/console-sdks.md @@ -1,7 +1,7 @@ --- -id: platforms-further-reading +id: platforms-console-sdks title: Console SDKs -slug: /platforms/console-sdks/ +slug: /platforms/console-sdks sidebar_position: 4 --- diff --git a/public/Console Platforms/GDK.md b/public/console-platforms/gdk.md similarity index 99% rename from public/Console Platforms/GDK.md rename to public/console-platforms/gdk.md index 444f099..3129968 100755 --- a/public/Console Platforms/GDK.md +++ b/public/console-platforms/gdk.md @@ -1,7 +1,7 @@ --- id: platforms-gdk title: Xbox One & Xbox Series X/S -slug: /platforms/gdk/ +slug: /platforms/gdk sidebar_position: 3 --- import CrossLink from '@site/src/components/CrossLink' diff --git a/public/Console Platforms/images/console-support/nintendo_verification.png b/public/console-platforms/images/console-support/nintendo_verification.png similarity index 100% rename from public/Console Platforms/images/console-support/nintendo_verification.png rename to public/console-platforms/images/console-support/nintendo_verification.png diff --git a/public/Console Platforms/images/console-support/psn_auth_web.png b/public/console-platforms/images/console-support/psn_auth_web.png similarity index 100% rename from public/Console Platforms/images/console-support/psn_auth_web.png rename to public/console-platforms/images/console-support/psn_auth_web.png diff --git a/public/Console Platforms/images/console-support/report-dialog.png b/public/console-platforms/images/console-support/report-dialog.png similarity index 100% rename from public/Console Platforms/images/console-support/report-dialog.png rename to public/console-platforms/images/console-support/report-dialog.png diff --git a/public/Console Platforms/images/console-support/skaterxl_ui.png b/public/console-platforms/images/console-support/skaterxl_ui.png similarity index 100% rename from public/Console Platforms/images/console-support/skaterxl_ui.png rename to public/console-platforms/images/console-support/skaterxl_ui.png diff --git a/public/Console Platforms/images/console-support/snowrunner_ui.jpg b/public/console-platforms/images/console-support/snowrunner_ui.jpg similarity index 100% rename from public/Console Platforms/images/console-support/snowrunner_ui.jpg rename to public/console-platforms/images/console-support/snowrunner_ui.jpg diff --git a/public/Console Platforms/images/console-support/submission_flow.png b/public/console-platforms/images/console-support/submission_flow.png similarity index 100% rename from public/Console Platforms/images/console-support/submission_flow.png rename to public/console-platforms/images/console-support/submission_flow.png diff --git a/public/Console Platforms/images/console-support/xbox_auth_web.png b/public/console-platforms/images/console-support/xbox_auth_web.png similarity index 100% rename from public/Console Platforms/images/console-support/xbox_auth_web.png rename to public/console-platforms/images/console-support/xbox_auth_web.png diff --git a/public/Console Platforms/Overview.md b/public/console-platforms/overview.md similarity index 99% rename from public/Console Platforms/Overview.md rename to public/console-platforms/overview.md index 0d3d25d..574418f 100755 --- a/public/Console Platforms/Overview.md +++ b/public/console-platforms/overview.md @@ -1,7 +1,7 @@ --- id: platforms title: Supporting Console Platforms -slug: /platforms/ +slug: /platforms sidebar_position: 0 --- diff --git a/public/Console Platforms/PS4.md b/public/console-platforms/ps4.md similarity index 99% rename from public/Console Platforms/PS4.md rename to public/console-platforms/ps4.md index 4b499b0..edb3658 100755 --- a/public/Console Platforms/PS4.md +++ b/public/console-platforms/ps4.md @@ -1,7 +1,7 @@ --- id: platforms-playstation title: PlayStation®4 & PlayStation®5 -slug: /platforms/playstation/ +slug: /platforms/playstation sidebar_position: 1 --- import CrossLink from '@site/src/components/CrossLink' diff --git a/public/Console Platforms/Switch.md b/public/console-platforms/switch.md similarity index 99% rename from public/Console Platforms/Switch.md rename to public/console-platforms/switch.md index 02d8547..b70f8f0 100755 --- a/public/Console Platforms/Switch.md +++ b/public/console-platforms/switch.md @@ -1,7 +1,7 @@ --- id: platforms-switch title: Nintendo Switch -slug: /platforms/switch/ +slug: /platforms/switch sidebar_position: 2 --- import CrossLink from '@site/src/components/CrossLink' diff --git a/public/Game Management/Dependencies/dependencies.md b/public/game-management/dependencies/dependency_management.md similarity index 99% rename from public/Game Management/Dependencies/dependencies.md rename to public/game-management/dependencies/dependency_management.md index 2ce1006..0f2b59a 100644 --- a/public/Game Management/Dependencies/dependencies.md +++ b/public/game-management/dependencies/dependency_management.md @@ -1,7 +1,7 @@ --- id: dependency-management title: Dependency Management -slug: /dependency-management/ +slug: /dependency-management sidebar_position: 0 --- diff --git a/public/Game Management/Dependencies/images/game-dependency-settings.png b/public/game-management/dependencies/images/game-dependency-settings.png similarity index 100% rename from public/Game Management/Dependencies/images/game-dependency-settings.png rename to public/game-management/dependencies/images/game-dependency-settings.png diff --git a/public/Game Management/Dependencies/images/ugc-dependency-settings.png b/public/game-management/dependencies/images/ugc-dependency-settings.png similarity index 100% rename from public/Game Management/Dependencies/images/ugc-dependency-settings.png rename to public/game-management/dependencies/images/ugc-dependency-settings.png diff --git a/public/Game Management/Moderation/_category_.json b/public/game-management/moderation/_category_.json similarity index 100% rename from public/Game Management/Moderation/_category_.json rename to public/game-management/moderation/_category_.json diff --git a/public/Game Management/Moderation/Automated Scanning.md b/public/game-management/moderation/automated-scanning.md similarity index 98% rename from public/Game Management/Moderation/Automated Scanning.md rename to public/game-management/moderation/automated-scanning.md index aa78e8b..2fa1317 100755 --- a/public/Game Management/Moderation/Automated Scanning.md +++ b/public/game-management/moderation/automated-scanning.md @@ -1,7 +1,7 @@ --- id: automated-scanning title: Automated Scanning -slug: /moderation/automated-scanning/ +slug: /moderation/automated-scanning sidebar_position: 1 --- diff --git a/public/Game Management/Moderation/Community Reports.md b/public/game-management/moderation/community-reports.md similarity index 99% rename from public/Game Management/Moderation/Community Reports.md rename to public/game-management/moderation/community-reports.md index 98a6fe9..0f1818a 100755 --- a/public/Game Management/Moderation/Community Reports.md +++ b/public/game-management/moderation/community-reports.md @@ -1,7 +1,7 @@ --- id: community-reports title: Community Reports -slug: /moderation/community-reports/ +slug: /moderation/community-reports sidebar_position: 4 --- diff --git a/public/Game Management/Moderation/images/curation-settings.png b/public/game-management/moderation/images/curation-settings.png similarity index 100% rename from public/Game Management/Moderation/images/curation-settings.png rename to public/game-management/moderation/images/curation-settings.png diff --git a/public/Game Management/Moderation/images/deleted-options.png b/public/game-management/moderation/images/deleted-options.png similarity index 100% rename from public/Game Management/Moderation/images/deleted-options.png rename to public/game-management/moderation/images/deleted-options.png diff --git a/public/Game Management/Moderation/images/edit-ugc.png b/public/game-management/moderation/images/edit-ugc.png similarity index 100% rename from public/Game Management/Moderation/images/edit-ugc.png rename to public/game-management/moderation/images/edit-ugc.png diff --git a/public/Game Management/Moderation/images/file-scanning.png b/public/game-management/moderation/images/file-scanning.png similarity index 100% rename from public/Game Management/Moderation/images/file-scanning.png rename to public/game-management/moderation/images/file-scanning.png diff --git a/public/Game Management/Moderation/images/manage-permissions-popup.png b/public/game-management/moderation/images/manage-permissions-popup.png similarity index 100% rename from public/Game Management/Moderation/images/manage-permissions-popup.png rename to public/game-management/moderation/images/manage-permissions-popup.png diff --git a/public/Game Management/Moderation/images/manage-permissions.png b/public/game-management/moderation/images/manage-permissions.png similarity index 100% rename from public/Game Management/Moderation/images/manage-permissions.png rename to public/game-management/moderation/images/manage-permissions.png diff --git a/public/Game Management/Moderation/images/media-scanning.png b/public/game-management/moderation/images/media-scanning.png similarity index 100% rename from public/Game Management/Moderation/images/media-scanning.png rename to public/game-management/moderation/images/media-scanning.png diff --git a/public/Game Management/Moderation/images/moderation-queue.png b/public/game-management/moderation/images/moderation-queue.png similarity index 100% rename from public/Game Management/Moderation/images/moderation-queue.png rename to public/game-management/moderation/images/moderation-queue.png diff --git a/public/Game Management/Moderation/images/moderation-tabs.png b/public/game-management/moderation/images/moderation-tabs.png similarity index 100% rename from public/Game Management/Moderation/images/moderation-tabs.png rename to public/game-management/moderation/images/moderation-tabs.png diff --git a/public/Game Management/Moderation/images/moderation.png b/public/game-management/moderation/images/moderation.png similarity index 100% rename from public/Game Management/Moderation/images/moderation.png rename to public/game-management/moderation/images/moderation.png diff --git a/public/Game Management/Moderation/images/pending-approval.png b/public/game-management/moderation/images/pending-approval.png similarity index 100% rename from public/Game Management/Moderation/images/pending-approval.png rename to public/game-management/moderation/images/pending-approval.png diff --git a/public/Game Management/Moderation/images/pending-files.png b/public/game-management/moderation/images/pending-files.png similarity index 100% rename from public/Game Management/Moderation/images/pending-files.png rename to public/game-management/moderation/images/pending-files.png diff --git a/public/Game Management/Moderation/images/platform-moderation.png b/public/game-management/moderation/images/platform-moderation.png similarity index 100% rename from public/Game Management/Moderation/images/platform-moderation.png rename to public/game-management/moderation/images/platform-moderation.png diff --git a/public/Game Management/Moderation/images/regex.png b/public/game-management/moderation/images/regex.png similarity index 100% rename from public/Game Management/Moderation/images/regex.png rename to public/game-management/moderation/images/regex.png diff --git a/public/Game Management/Moderation/images/report.png b/public/game-management/moderation/images/report.png similarity index 100% rename from public/Game Management/Moderation/images/report.png rename to public/game-management/moderation/images/report.png diff --git a/public/Game Management/Moderation/images/reported-mods.jpeg b/public/game-management/moderation/images/reported-mods.jpeg similarity index 100% rename from public/Game Management/Moderation/images/reported-mods.jpeg rename to public/game-management/moderation/images/reported-mods.jpeg diff --git a/public/Game Management/Moderation/images/request-details.png b/public/game-management/moderation/images/request-details.png similarity index 100% rename from public/Game Management/Moderation/images/request-details.png rename to public/game-management/moderation/images/request-details.png diff --git a/public/Game Management/Moderation/images/request-history.png b/public/game-management/moderation/images/request-history.png similarity index 100% rename from public/Game Management/Moderation/images/request-history.png rename to public/game-management/moderation/images/request-history.png diff --git a/public/Game Management/Moderation/images/restricted-users.png b/public/game-management/moderation/images/restricted-users.png similarity index 100% rename from public/Game Management/Moderation/images/restricted-users.png rename to public/game-management/moderation/images/restricted-users.png diff --git a/public/Game Management/Moderation/images/review-files.png b/public/game-management/moderation/images/review-files.png similarity index 100% rename from public/Game Management/Moderation/images/review-files.png rename to public/game-management/moderation/images/review-files.png diff --git a/public/Game Management/Moderation/images/rules-deny.png b/public/game-management/moderation/images/rules-deny.png similarity index 100% rename from public/Game Management/Moderation/images/rules-deny.png rename to public/game-management/moderation/images/rules-deny.png diff --git a/public/Game Management/Moderation/images/rules-engine-ui.png b/public/game-management/moderation/images/rules-engine-ui.png similarity index 100% rename from public/Game Management/Moderation/images/rules-engine-ui.png rename to public/game-management/moderation/images/rules-engine-ui.png diff --git a/public/Game Management/Moderation/images/rules-flow.png b/public/game-management/moderation/images/rules-flow.png similarity index 100% rename from public/Game Management/Moderation/images/rules-flow.png rename to public/game-management/moderation/images/rules-flow.png diff --git a/public/Game Management/Moderation/images/text-scanning.png b/public/game-management/moderation/images/text-scanning.png similarity index 100% rename from public/Game Management/Moderation/images/text-scanning.png rename to public/game-management/moderation/images/text-scanning.png diff --git a/public/Game Management/Moderation/images/webhook-details.png b/public/game-management/moderation/images/webhook-details.png similarity index 100% rename from public/Game Management/Moderation/images/webhook-details.png rename to public/game-management/moderation/images/webhook-details.png diff --git a/public/Game Management/Moderation/images/webhook-history.png b/public/game-management/moderation/images/webhook-history.png similarity index 100% rename from public/Game Management/Moderation/images/webhook-history.png rename to public/game-management/moderation/images/webhook-history.png diff --git a/public/Game Management/Moderation/Manual Curation.md b/public/game-management/moderation/manual-curation.md similarity index 99% rename from public/Game Management/Moderation/Manual Curation.md rename to public/game-management/moderation/manual-curation.md index 1504106..1aca19d 100755 --- a/public/Game Management/Moderation/Manual Curation.md +++ b/public/game-management/moderation/manual-curation.md @@ -1,7 +1,7 @@ --- id: manual-curation title: Manual Curation -slug: /moderation/manual-curation/ +slug: /moderation/manual-curation sidebar_position: 3 --- diff --git a/public/Game Management/Moderation/Overview.md b/public/game-management/moderation/moderation.md similarity index 98% rename from public/Game Management/Moderation/Overview.md rename to public/game-management/moderation/moderation.md index 1162ead..899b133 100755 --- a/public/Game Management/Moderation/Overview.md +++ b/public/game-management/moderation/moderation.md @@ -1,12 +1,12 @@ --- id: moderation -title: Overview -slug: /moderation/ +title: Moderation +slug: /moderation sidebar_position: 0 --- -# Overview +# Moderation [mod.io](https://mod.io/) offers four levels of moderation: diff --git a/public/Game Management/Moderation/rules-engine-examples.md b/public/game-management/moderation/rules-engine-examples.md similarity index 100% rename from public/Game Management/Moderation/rules-engine-examples.md rename to public/game-management/moderation/rules-engine-examples.md diff --git a/public/Game Management/Moderation/rules-engine-monitoring.md b/public/game-management/moderation/rules-engine-monitoring.md similarity index 100% rename from public/Game Management/Moderation/rules-engine-monitoring.md rename to public/game-management/moderation/rules-engine-monitoring.md diff --git a/public/Game Management/Moderation/rules-engine-setup.md b/public/game-management/moderation/rules-engine-setup.md similarity index 100% rename from public/Game Management/Moderation/rules-engine-setup.md rename to public/game-management/moderation/rules-engine-setup.md diff --git a/public/Game Management/Moderation/rules-engine-webhooks.md b/public/game-management/moderation/rules-engine-webhooks.md similarity index 100% rename from public/Game Management/Moderation/rules-engine-webhooks.md rename to public/game-management/moderation/rules-engine-webhooks.md diff --git a/public/Game Management/Moderation/Rules Engine.md b/public/game-management/moderation/rules_engine.md similarity index 96% rename from public/Game Management/Moderation/Rules Engine.md rename to public/game-management/moderation/rules_engine.md index 6063ac3..6fb7c4c 100755 --- a/public/Game Management/Moderation/Rules Engine.md +++ b/public/game-management/moderation/rules_engine.md @@ -1,7 +1,7 @@ --- id: rules-engine title: Rules Engine -slug: /moderation/rules-engine/ +slug: /moderation/rules-engine sidebar_position: 0 --- diff --git a/public/modio/Overview.md b/public/modio/getting-started.md similarity index 100% rename from public/modio/Overview.md rename to public/modio/getting-started.md diff --git a/public/modio/Launching Your Game.md b/public/modio/launch-your-game.md similarity index 100% rename from public/modio/Launching Your Game.md rename to public/modio/launch-your-game.md diff --git a/public/modio/premium-ugc.md b/public/modio/premium-features.md similarity index 100% rename from public/modio/premium-ugc.md rename to public/modio/premium-features.md diff --git a/public/modio/Terms & User Consent.md b/public/modio/terms-user-consent.md similarity index 100% rename from public/modio/Terms & User Consent.md rename to public/modio/terms-user-consent.md diff --git a/public/REST API/Error Codes.md b/public/rest-api/error-codes.md similarity index 100% rename from public/REST API/Error Codes.md rename to public/rest-api/error-codes.md diff --git a/public/REST API/Rate Limiting.md b/public/rest-api/rate-limiting.md similarity index 93% rename from public/REST API/Rate Limiting.md rename to public/rest-api/rate-limiting.md index 630bbfb..6b82f63 100644 --- a/public/REST API/Rate Limiting.md +++ b/public/rest-api/rate-limiting.md @@ -2,7 +2,7 @@ id: rate-limiting title: Rate Limiting slug: /restapi/rate-limiting -sidebar_position: 1 +sidebar_position: 0 --- # Rate Limiting diff --git a/public/Support/Key Contacts.md b/public/support/contacts.md similarity index 100% rename from public/Support/Key Contacts.md rename to public/support/contacts.md diff --git a/public/Support/Knowledge Base.md b/public/support/knowledge-base.md similarity index 89% rename from public/Support/Knowledge Base.md rename to public/support/knowledge-base.md index a437093..a155cc5 100755 --- a/public/Support/Knowledge Base.md +++ b/public/support/knowledge-base.md @@ -1,7 +1,7 @@ --- id: support-knowledge-base title: Knowledge Base -slug: /support/knowledge-base/ +slug: /support/knowledge-base sidebar_position: 0 --- diff --git a/public/Support/Searching.md b/public/support/search.md similarity index 91% rename from public/Support/Searching.md rename to public/support/search.md index d5b8ece..201e654 100755 --- a/public/Support/Searching.md +++ b/public/support/search.md @@ -1,7 +1,7 @@ --- id: support-search title: Search by id -slug: /support/search-by-id/ +slug: /support/search-by-id sidebar_position: 2 --- diff --git a/public/web/authentication/openid.mdx b/public/web/authentication/openid.md similarity index 100% rename from public/web/authentication/openid.mdx rename to public/web/authentication/openid.md diff --git a/public/web/authentication/overview.mdx b/public/web/authentication/overview.md similarity index 100% rename from public/web/authentication/overview.mdx rename to public/web/authentication/overview.md diff --git a/public/web/authentication/s2s.mdx b/public/web/authentication/s2s.md similarity index 100% rename from public/web/authentication/s2s.mdx rename to public/web/authentication/s2s.md diff --git a/public/web/authentication/website-studio-sso.mdx b/public/web/authentication/website-studio-sso.md similarity index 100% rename from public/web/authentication/website-studio-sso.mdx rename to public/web/authentication/website-studio-sso.md diff --git a/public/web/iap/modio-as-purchase-server.mdx b/public/web/iap/modio-as-purchase-server.md similarity index 100% rename from public/web/iap/modio-as-purchase-server.mdx rename to public/web/iap/modio-as-purchase-server.md diff --git a/public/web/iap/overview.mdx b/public/web/iap/overview.md similarity index 100% rename from public/web/iap/overview.mdx rename to public/web/iap/overview.md diff --git a/public/web/iap/studio-as-purchase-server.mdx b/public/web/iap/studio-as-purchase-server.md similarity index 100% rename from public/web/iap/studio-as-purchase-server.mdx rename to public/web/iap/studio-as-purchase-server.md diff --git a/sidebars.js b/sidebars.js new file mode 100644 index 0000000..1687860 --- /dev/null +++ b/sidebars.js @@ -0,0 +1,233 @@ +import 'dotenv/config' + +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ + +// @ts-check + +const url = process.env.URL || 'http://localhost:3000' +const startStyle = ` +
+` +const endStyle = '
' +const startStylePush = `
${startStyle}` + +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const sidebars = { + // By default, Docusaurus generates a sidebar from the docs folder structure + sidebar: [ + // mod.io + // Integration + { + type: 'html', + value: `${startStylePush}MOD.IO${endStyle}`, + defaultStyle: true, + }, + { + type: 'autogenerated', dirName: 'modio', + }, + // Integration + { + type: 'html', + value: `${startStylePush}GAME INTEGRATION${endStyle}`, + defaultStyle: true, + }, + { + type: 'category', + label: 'Unreal', + link: {type: 'doc', id: 'unreal/index-unreal'}, + items: ['unreal/installation-and-setup', 'unreal/getting-started', 'unreal/ui-getting-started', 'unreal/profiling', 'unreal/mod-creation-tool', 'unreal/android-configuration', + { + type: 'link', + label: 'Unreal Reference', + href: `${url}/unrealref/#_classes`, + }, + ], + }, + { + type: 'category', + label: 'Unity', + link: {type: 'doc', id: 'integration/unity/unity'}, + items: ['integration/unity/unity-setup', 'integration/unity/unity-getting-started', 'integration/unity/unity-ugc-browser', 'integration/unity/unity-marketplace', + { + type: 'link', + label: 'Unity Reference', + href: `${url}/unityref/`, + }, + ], + }, + { + type: 'category', + label: 'C++ SDK', + link: {type: 'doc', id: 'sdk/index-sdk'}, + items: [ + 'sdk/installation-and-setup', 'sdk/getting-started', + { + type: 'category', + label: 'Windows', + link: {type: 'doc', id: 'sdk/win32/windows-getting-started'}, + items: ['sdk/win32/windows-cmake-integration'] + }, + { + type: 'category', + label: 'Linux', + link: {type: 'doc', id: 'sdk/linux/linux-getting-started'}, + items: ['sdk/linux/linux-cmake-integration'] + }, + { + type: 'category', + label: 'Mac', + link: {type: 'doc', id: 'sdk/macos/mac-getting-started'}, + items: ['sdk/macos/mac-cmake-integration'] + }, + { + type: 'category', + label: 'iOS', + link: {type: 'doc', id: 'sdk/ios/ios-getting-started'}, + items: ['sdk/ios/ios-cmake-integration'] + }, + { + type: 'category', + label: 'Android', + link: {type: 'doc', id: 'sdk/android/android-getting-started'}, + items: ['sdk/android/android-cmake-integration'] + }, + { + type: 'link', + label: 'C++ SDK Reference', + href: `${url}/cppsdkref/#_functions`, + }, + ], + }, + // Console Platforms + { + type: 'html', + value: `${startStylePush}CONSOLE PLATFORMS${endStyle}`, + defaultStyle: true, + }, + { + type: 'doc', + id: 'console-platforms/platforms', + label: 'Supporting Console Platforms', + }, + { + type: 'doc', + id: 'console-platforms/platforms-playstation', + label: 'PlayStation\u00ae4 & PlayStation\u00ae5', + }, + { + type: 'doc', + id: 'console-platforms/platforms-switch', + label: 'Nintendo Switch', + }, + { + type: 'doc', + id: 'console-platforms/platforms-gdk', + label: 'Xbox One & Xbox Series X/S', + }, + { + type: 'doc', + id: 'console-platforms/platforms-console-sdks', + label: 'Console SDKs', + }, + // Game Management + { + type: 'html', + value: `${startStylePush}GAME MANAGEMENT${endStyle}`, + defaultStyle: true, + }, + // { + // type: 'category', + // label: 'Monetization', + // items: ['Game Management/Monetization/monetization', 'Game Management/Monetization/getting-started'], + // }, + { + type: 'category', + label: 'Moderation', + link: {type: 'doc', id: 'game-management/moderation/moderation'}, + items: ['game-Management/moderation/automated-scanning', 'game-management/moderation/manual-curation', 'game-management/moderation/community-reports', + + { + type: 'category', + label: 'Rules Engine', + link: {type: 'doc', id: 'game-management/moderation/rules-engine'}, + items: ['game-management/moderation/rules-engine-setup', 'game-management/moderation/rules-engine-webhooks', 'game-management/moderation/rules-engine-monitoring', 'game-management/moderation/rules-engine-examples'], + }, + ], + }, + { + type: 'doc', + id: 'game-management/dependencies/dependency-management', + label: 'Dependencies', + }, + // Remove Metrics until we get the docs written + // { + // type: 'category', + // label: 'Metrics', + // items: ['Game Management/Metrics/metrics', 'Game Management/Metrics/metrics-dashboards', 'Game Management/Metrics/metrics-trending', 'Game Management/Metrics/metrics-ccu', 'Game Management/Metrics/metrics-export'], + // }, + // WEB SERVICES + { + type: 'html', + value: `${startStylePush}WEB SERVICES${endStyle}`, + defaultStyle: true, + }, + { + type: 'category', + label: 'Authentication', + items: [, + + { + type: 'category', + label: 'For Players', + link: {type: 'doc', id: 'web/authentication/overview'}, + items: ['web/authentication/openid', 'web/authentication/website-studio-sso'], + }, + { + type: 'doc', + id: 'web/authentication/s2s', + label: 'For Web Servers', + }, + ] + }, + { + type: 'category', + label: 'Marketplace', + link: {type: 'doc', id: 'web/iap/overview'}, + items: ['web/iap/studio-as-purchase-server'], + }, + // REST API + { + type: 'html', + value: `${startStylePush}REST API${endStyle}`, + defaultStyle: true, + }, + { + type: 'autogenerated', dirName: 'rest-api', + }, + { + type: 'link', + label: 'REST API Reference', + href: `${url}/restapiref/`, + }, + // Support + { + type: 'html', + value: `${startStylePush}SUPPORT${endStyle}`, + defaultStyle: true, + }, + { + type: 'autogenerated', dirName: 'support', + }, + ], +}; + +export default sidebars; \ No newline at end of file From 98dae73a1a1b42d1c857929ec2f30cb33130938e Mon Sep 17 00:00:00 2001 From: patrickvuleta <161555144+patrickvuleta@users.noreply.github.com> Date: Wed, 26 Jun 2024 17:08:20 +1000 Subject: [PATCH 2/2] update action --- .github/workflows/push-modio-docs.yml | 25 +++++++++++++++++++------ sidebars.js => menu/sidebars.js | 0 2 files changed, 19 insertions(+), 6 deletions(-) rename sidebars.js => menu/sidebars.js (100%) diff --git a/.github/workflows/push-modio-docs.yml b/.github/workflows/push-modio-docs.yml index f0d7b6f..d21bca5 100644 --- a/.github/workflows/push-modio-docs.yml +++ b/.github/workflows/push-modio-docs.yml @@ -21,7 +21,7 @@ jobs: env: API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }} with: - source-directory: 'public/Console Platforms' + source-directory: 'public/console-platforms' destination-github-username: "modio" destination-repository-name: "modio-docs-internal" commit-message: "docs: updating public docs (console platforms) from modio-docs repo" @@ -33,7 +33,7 @@ jobs: env: API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }} with: - source-directory: 'public/Game Management/Dependencies' + source-directory: 'public/game-management/dependencies' destination-github-username: "modio" destination-repository-name: "modio-docs-internal" commit-message: "docs: updating public docs (dependencies) from modio-docs repo" @@ -57,7 +57,7 @@ jobs: env: API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }} with: - source-directory: 'public/Game Management/Moderation' + source-directory: 'public/game-management/moderation' destination-github-username: "modio" destination-repository-name: "modio-docs-internal" commit-message: "docs: updating public docs (moderation) from modio-docs repo" @@ -69,7 +69,7 @@ jobs: env: API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }} with: - source-directory: 'public/Integration' + source-directory: 'public/integration' destination-github-username: "modio" destination-repository-name: "modio-docs-internal" commit-message: "docs: updating public docs (integration) from modio-docs repo" @@ -81,7 +81,7 @@ jobs: env: API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }} with: - source-directory: 'public/REST API' + source-directory: 'public/rest-api' destination-github-username: "modio" destination-repository-name: "modio-docs-internal" commit-message: "docs: updating public docs (REST API) from modio-docs repo" @@ -93,7 +93,7 @@ jobs: env: API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }} with: - source-directory: 'public/Support' + source-directory: 'public/support' destination-github-username: "modio" destination-repository-name: "modio-docs-internal" commit-message: "docs: updating public docs (support) from modio-docs repo" @@ -123,3 +123,16 @@ jobs: commit-message: "docs: updating public docs (web) from modio-docs repo" target-branch: main target-directory: public/web + + + - name: Push menu structure to modio-docs-internal + uses: cpina/github-action-push-to-another-repository@main + env: + API_TOKEN_GITHUB: ${{ secrets.DOCS_ACCESS_TOKEN }} + with: + source-directory: 'menu' + destination-github-username: "modio" + destination-repository-name: "modio-docs-internal" + commit-message: "docs: update public menu from modio-docs repo" + target-branch: main + target-directory: / diff --git a/sidebars.js b/menu/sidebars.js similarity index 100% rename from sidebars.js rename to menu/sidebars.js