From 7bfd4944b53b241ad533162c018b9a6568ae4354 Mon Sep 17 00:00:00 2001 From: "T.J. Kotha" <112996779+tkothadev@users.noreply.github.com> Date: Thu, 14 Dec 2023 04:13:15 +0000 Subject: [PATCH] initial documentation updates for recent exporter changes for point release (#2519) * initial documentation updates for recent exporter changes for point release Signed-off-by: TJ Kotha * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Gene Walters <32776221+AMZN-Gene@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * addressed feedback Signed-off-by: TJ Kotha * removed unnecessary warning for profile builds Signed-off-by: TJ Kotha * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Gene Walters <32776221+AMZN-Gene@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * Update content/docs/user-guide/packaging/project-export/project-export-cli.md Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> * adding wildcard documentation for seed parameters Signed-off-by: TJ Kotha * splitting argument table into separate unique entries Signed-off-by: TJ Kotha * minor sentence improvement Signed-off-by: TJ Kotha * minor sentence improvements Signed-off-by: TJ Kotha * split up snippets into smaller sections Signed-off-by: TJ Kotha --------- Signed-off-by: TJ Kotha Signed-off-by: T.J. Kotha <112996779+tkothadev@users.noreply.github.com> Co-authored-by: TJ Kotha Co-authored-by: Steve Pham <82231385+spham-amzn@users.noreply.github.com> Co-authored-by: Alex Peterson <26804013+AMZN-alexpete@users.noreply.github.com> Co-authored-by: Gene Walters <32776221+AMZN-Gene@users.noreply.github.com> --- .../project-export/project-export-cli.md | 20 ------------------- 1 file changed, 20 deletions(-) diff --git a/content/docs/user-guide/packaging/project-export/project-export-cli.md b/content/docs/user-guide/packaging/project-export/project-export-cli.md index 82f9a6cfbb5..2774b5fb7db 100644 --- a/content/docs/user-guide/packaging/project-export/project-export-cli.md +++ b/content/docs/user-guide/packaging/project-export/project-export-cli.md @@ -102,21 +102,6 @@ or in condensed form: \scripts\o3de.bat export-project -es C:\..\path\to\export-script -pp C:\..\path\to\project-folder -ll INFO ``` -### Project Template - -Project Export functionality is also available on a per-project basis. This is because there are helper export scripts that are included in the Project Templates, as can be seen with [`package.bat`](https://github.com/o3de/o3de/blob/f25503785829c3eb75d3f00420d2072985d5ed05/Templates/DefaultProject/Template/package.bat) and [`package.sh` for Unix](https://github.com/o3de/o3de/blob/f25503785829c3eb75d3f00420d2072985d5ed05/Templates/DefaultProject/Template/package.sh). These scripts are included at the root folder of every new Project created with the `DefaultProject` template. - -The package scripts pre-populate the relevant arguments for the given project, and then call `export-project` on the user's behalf. - -In order to use it, simply run the following command (assuming project has already been created and registered): -``` -# On Windows -\path\to\project\package.bat - -#On Unix -\path\to\project\package.sh -``` - ## Standard Export Script O3DE now ships with a [standard project export script](https://github.com/o3de/o3de/blob/753480ec930e55f3431f92ed7b974ba7f9e73a13/scripts/o3de/ExportScripts/export_source_built_project.py), capable of automating most typical use cases of projects. The code and API are provided so that users with more particular needs can investigate, expand or modify the code as necessary. Currently this script only supports Windows and Linux platforms, and does not handle deployment to external services. @@ -189,11 +174,6 @@ An example usage of the entire `export-project` command, including this script, ``` Where `O3DE_ENGINE_PATH`, `O3DE_PROJECT_PATH` and `OUTPUT_PATH` are environment variables. This single invocation should be all that is needed to fully export MultiplayerSample into a release directory ready for distribution. -{{< important >}} ---no-monolithic-build and --config profile is required when building from an O3DE installer or SDK. -See [Installed Engine Fails to Export Monolithic Release.](https://github.com/o3de/o3de/issues/17203) -{{< /important >}} - For more information on how to export the MultiplayerSample project using the CLI, please see [these instructions](https://github.com/o3de/o3de-multiplayersample/blob/f00b3035285b695b2dbd1b1e59912973f4e1a32f/Documentation/O3DEMPSProjectExportTesting.md). ## Export Script Configurations