Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 33 additions & 77 deletions .github/workflows/stride-docs-release-azure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@

name: Build Stride Docs for Azure Web App Release 🚀

permissions:
contents: write # required to create releases/tags

env:
COMMON_SETTINGS_PATH: en/docfx.json
VERSION: "2.0.0.${{ github.run_number }}"
Expand All @@ -23,90 +20,54 @@ on:
- .gitignore
- '.github/**'
workflow_dispatch:
inputs:
skipPdfBuilding:
description: Skip PDF building
required: true
default: true
type: boolean
skipApiBuilding:
description: Skip API building
required: true
default: true
type: boolean
strideBranch:
description: Stride branch to checkout
required: true
default: master
type: string

permissions:
contents: write # required to create releases/tags

jobs:
build:
# Run this job only if the repository is 'stride3d/stride-docs'
if: github.repository == 'stride3d/stride-docs'
runs-on: windows-latest
runs-on: windows-2025-vs2026

steps:
- name: .NET SDK Setup
uses: actions/setup-dotnet@v5
with:
dotnet-version: 10.x

# Checkout the Stride Docs repository from the branch that triggered the workflow
- name: Checkout Stride Docs
uses: actions/checkout@v6
with:
path: ${{ env.DOCS_PATH }}
lfs: true

- name: Set Version in docfx.json
run: |
$settingsContent = Get-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Raw
$updatedDocFxJsonContent = $settingsContent -replace '2.0.0.x', "${{ env.VERSION }}"
Set-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Value $updatedDocFxJsonContent
shell: pwsh

# Checkout the Stride repository from the default branch
- name: Checkout Stride (note the LFS)
uses: actions/checkout@v6
- name: Run Global Setup
id: setup
uses: ./stride-docs/.github/actions/setup-stride
with:
repository: stride3d/stride
token: ${{ secrets.GITHUB_TOKEN }}
path: stride
lfs: true
ref: master

# Temporary solution till the new docfx is available
# - name: Checkout DocFX
# uses: actions/checkout@v6
# with:
# repository: dotnet/docfx
# # Tested commit
# ref: 917cda864650279e0bbe50b852cb98601e5efa4d
# path: docfx-build
# fetch-depth: 0

# - name: Restore npm dependencies
# run: npm install
# working-directory: docfx-build/templates

# - name: Build site templates
# run: npm run build
# working-directory: docfx-build/templates

# - name: Build DocFX from PR
# run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
# working-directory: docfx-build
# shell: pwsh

# - name: Build Install DocFX
# run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
# working-directory: docfx-build
# shell: pwsh
# End of Temporary solution

- name: Install DocFX
# This installs the latest version of DocFX and may introduce breaking changes
# run: dotnet tool update -g docfx
# This installs a specific, tested version of DocFX.
run: dotnet tool update -g docfx --version 2.78.5

- name: Build documentation
run: ./build-all.bat
working-directory: ${{ env.DOCS_PATH }}

- name: Compress artifact
run: 7z a -r DocFX-app.zip ./${{ env.DOCS_PATH }}/_site/*
github-token: ${{ secrets.GITHUB_TOKEN }}
skip-pdf-building: ${{ inputs.skipPdfBuilding }}
skip-api-building: ${{ inputs.skipApiBuilding }}
stride-branch: ${{ inputs.strideBranch || 'master' }}

- name: Upload artifact for deployment job
uses: actions/upload-artifact@v6
uses: actions/upload-artifact@v7
with:
name: DocFX-app
path: DocFX-app.zip
path: ./${{ env.DOCS_PATH }}/_site

- name: Create GitHub Release
run: |
Expand All @@ -117,7 +78,7 @@ jobs:

deploy:
if: github.repository == 'stride3d/stride-docs'
runs-on: windows-latest
runs-on: windows-2025-vs2026

needs: build
environment:
Expand All @@ -126,15 +87,10 @@ jobs:

steps:
- name: Download artifact from build job
uses: actions/download-artifact@v7
uses: actions/download-artifact@v8
with:
name: DocFX-app

# - name: List current directory
# run: ls

- name: Decompress artifact
run: 7z x DocFX-app.zip "-o./${{ env.DOCS_PATH }}/_site"
path: ./${{ env.DOCS_PATH }}/_site

- name: Deploy to Azure Web App
id: deploy-to-webapp
Expand All @@ -143,4 +99,4 @@ jobs:
app-name: 'stride-doc'
slot-name: 'Production'
publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_4803638D673FA67D0C8650F34C4FA9D1 }}
package: ./${{ env.DOCS_PATH }}/_site
package: ./${{ env.DOCS_PATH }}/_site
90 changes: 27 additions & 63 deletions .github/workflows/stride-docs-release-fast-track-azure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,94 +4,58 @@
# The Fast Track skips creating artifacts and compressing them
name: Build Stride Docs (Fast Track) for Azure Web App Release 🚀

permissions:
contents: write # required to create releases/tags

env:
COMMON_SETTINGS_PATH: en/docfx.json
VERSION: "2.0.0.${{ github.run_number }}"
DOCS_PATH: stride-docs

on:
workflow_dispatch:
inputs:
skipPdfBuilding:
description: Skip PDF building
required: true
default: true
type: boolean
skipApiBuilding:
description: Skip API building
required: true
default: true
type: boolean
strideBranch:
description: Stride branch to checkout
required: true
default: master
type: string

permissions:
contents: read

jobs:
build-deploy:
# Run this job only if the repository is 'stride3d/stride-docs'
if: github.repository == 'stride3d/stride-docs'
runs-on: windows-latest
runs-on: windows-2025-vs2026

environment:
name: 'Production'

steps:
- name: .NET SDK Setup
uses: actions/setup-dotnet@v5
with:
dotnet-version: 10.x

# Checkout the Stride Docs repository from the branch that triggered the workflow
- name: Checkout Stride Docs
uses: actions/checkout@v6
with:
path: ${{ env.DOCS_PATH }}
lfs: true

- name: Set Version in docfx.json
run: |
$settingsContent = Get-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Raw
$updatedDocFxJsonContent = $settingsContent -replace '2.0.0.x', "${{ env.VERSION }}"
Set-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Value $updatedDocFxJsonContent
shell: pwsh

# Checkout the Stride repository from the default branch
- name: Checkout Stride (note the LFS)
uses: actions/checkout@v6
- name: Run Global Setup
id: setup
uses: ./stride-docs/.github/actions/setup-stride
with:
repository: stride3d/stride
token: ${{ secrets.GITHUB_TOKEN }}
path: stride
lfs: true
ref: master

# Temporary solution till the new docfx is available
# - name: Checkout DocFX
# uses: actions/checkout@v6
# with:
# repository: dotnet/docfx
# # Tested commit
# ref: 917cda864650279e0bbe50b852cb98601e5efa4d
# path: docfx-build
# fetch-depth: 0

# - name: Restore npm dependencies
# run: npm install
# working-directory: docfx-build/templates

# - name: Build site templates
# run: npm run build
# working-directory: docfx-build/templates

# - name: Build DocFX from PR
# run: dotnet pack src/docfx -c Release /p:Version=2.9-stride -o drop/nuget
# working-directory: docfx-build
# shell: pwsh

# - name: Build Install DocFX
# run: dotnet tool install -g docfx --version 2.9-stride --add-source drop/nuget
# working-directory: docfx-build
# shell: pwsh
# End of Temporary solution

- name: Install DocFX
# This installs the latest version of DocFX and may introduce breaking changes
# run: dotnet tool update -g docfx
# This installs a specific, tested version of DocFX.
run: dotnet tool update -g docfx --version 2.78.5

- name: Build documentation
run: ./build-all.bat
working-directory: ${{ env.DOCS_PATH }}
github-token: ${{ secrets.GITHUB_TOKEN }}
skip-pdf-building: ${{ inputs.skipPdfBuilding }}
skip-api-building: ${{ inputs.skipApiBuilding }}
stride-branch: ${{ inputs.strideBranch }}

- name: Deploy to Azure Web App
id: deploy-to-webapp
Expand Down
6 changes: 3 additions & 3 deletions en/manual/game-studio/add-entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,12 @@ You can duplicate an entity along with all its properties. Duplicating an entity
The entity and all its properties are duplicated.

<video controls autoplay loop height="360" width="480">
<source src="../get-started/media/populate-scene-duplicate-entity.mp4" type="video/mp4">
<source src="media/populate-scene-duplicate-entity.mp4" type="video/mp4">
</video>

Alternatively, right-click the entity and select **Duplicate selected entities**.

![Duplicate selected entities](../get-started/media/duplicate-selected-entities.png)
![Duplicate selected entities](media/duplicate-selected-entities.png)

## Rename an entity

Expand All @@ -87,4 +87,4 @@ Alternatively, right-click the entity and select **Duplicate selected entities**

## See also

* [Manage scenes](manage-scenes.md)
* [Manage scenes](manage-scenes.md)
4 changes: 2 additions & 2 deletions en/manual/game-studio/assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Some assets require **resource files**. For example, texture assets need image f

You can compile and optimize assets with a special compiler provided by Stride. Compiled assets are packed together as reusable bundles.

![Assets displayed in the Asset View](../get-started/media/asset-creation-asset-view-tab-knight.png)
![Assets displayed in the Asset View](media/asset-creation-asset-view-tab-knight.png)

You can:

Expand All @@ -32,4 +32,4 @@ You can:

* [Create assets](create-assets.md)
* [Manage assets](manage-assets.md)
* [Use assets](use-assets.md)
* [Use assets](use-assets.md)
6 changes: 3 additions & 3 deletions en/manual/game-studio/create-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ There are two ways to create assets:

2. Select the type of asset you want to create.

![Select asset type](../get-started/media/asset-creation-create-new-asset-asset-view-tab.png)
![Select asset type](media/asset-creation-create-new-asset-asset-view-tab.png)

Game Studio displays a list of asset templates. These are assets configured for a specific use.

3. Select the right template for your asset.

Game Studio adds the asset to the Asset View:

![Asset added to Asset View' tab](../get-started/media/asset-creation-asset-view-tab-procedural-model.png)
![Asset added to Asset View' tab](media/asset-creation-asset-view-tab-procedural-model.png)

> [!Note]
> Some assets, such as textures, require a resource file. When you add these assets, Game Studio prompts you for a resource file.
Expand Down Expand Up @@ -63,4 +63,4 @@ Game Studio automatically imports all dependencies in the resource files and cre
## See also

* [Manage assets](manage-assets.md)
* [Use assets](use-assets.md)
* [Use assets](use-assets.md)
2 changes: 1 addition & 1 deletion en/manual/game-studio/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Game Studio is also integrated with your Visual Studio projects, so you can seam

## Interface

![Game Studio](../get-started/media/game-studio-main-interface.webp)
![Game Studio](media/game-studio-main-interface.webp)

The **asset editor** (1) is used to edit assets and scenes. Some asset types, such as [scenes](create-a-scene.md), have dedicated editors where you can make complex changes to the asset. To open a dedicated editor (when available), double-click the asset or right-click it and select **Edit asset**.

Expand Down
Loading