Skip to content

Commit

Permalink
Merge pull request #328 from stride3d/master
Browse files Browse the repository at this point in the history
Initiating deployment of latest docs updates to production
  • Loading branch information
VaclavElias authored Sep 18, 2024
2 parents 130323c + 18f5c1b commit fcbb21c
Show file tree
Hide file tree
Showing 43 changed files with 685 additions and 178 deletions.
1 change: 1 addition & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ changelog:
exclude:
labels:
- ignore-for-release
- deployment
authors:
- dependabot
categories:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/stride-docs-github.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
# 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.76.0
run: dotnet tool update -g docfx --version 2.77.0

- name: Build documentation
run: ./build-all.bat
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/stride-docs-release-azure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ jobs:
# 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.76.0
run: dotnet tool update -g docfx --version 2.77.0

- name: Build documentation
run: ./build-all.bat
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/stride-docs-release-fast-track-azure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
# 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.76.0
run: dotnet tool update -g docfx --version 2.77.0

- name: Build documentation
run: ./build-all.bat
Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/stride-docs-staging-azure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,13 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
path: stride
lfs: true
ref: master

- 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.76.0
run: dotnet tool update -g docfx --version 2.77.0

- name: Build documentation
run: ./build-all.bat
Expand Down Expand Up @@ -111,4 +112,4 @@ jobs:
app-name: 'stride-doc'
slot-name: 'staging'
publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_32FCD402B970463A9143B24C9B225749 }}
package: ./${{ env.DOCS_PATH }}/_site
package: ./${{ env.DOCS_PATH }}/_site
2 changes: 1 addition & 1 deletion .github/workflows/stride-docs-staging-fast-track-azure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
# 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.76.0
run: dotnet tool update -g docfx --version 2.77.0

- name: Build documentation
run: ./build-all.bat
Expand Down
24 changes: 20 additions & 4 deletions BuildDocs.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@
Switch parameter. If provided, the script will build documentation in all available languages and include API documentation.
.PARAMETER Version
The Version to build the Docs, the default is the latest version
.PARAMETER SkipPdfBuilding
Switch parameter. If provided, It skips Pdf generation step.
.EXAMPLE
.\BuildDocs.ps1 -BuildAll
In this example, the script will build the documentation in all available languages and include API documentation. Use this in GitHub Actions.
.EXAMPLE
.\BuildDocs.ps1
In this example, the script will prompt the user to select an operation and an optional language. If the user chooses to build the documentation, the script will also ask if they want to include API documentation.
.EXAMPLE
.\BuildDocs.ps1 -SkipPdfBuilding
#>

param (
Expand All @@ -30,6 +34,7 @@ param (
param([string] $CommandName,[string] $ParameterName,[string] $WordToComplete,[System.Management.Automation.Language.CommandAst] $CommandAst,[System.Collections.IDictionary] $FakeBoundParameters)
return (Get-Content $PSScriptRoot\versions.json -Encoding UTF8 | ConvertFrom-Json).versions
})]
[switch]$SkipPdfBuilding,
$Version = $((Get-Content $PSScriptRoot\versions.json -Encoding UTF8 | ConvertFrom-Json).versions | Sort-Object -Descending | Select-Object -First 1)
)

Expand Down Expand Up @@ -189,12 +194,23 @@ function Build-EnglishDoc {
# Output to both build.log and console
docfx build en/docfx.json -o $outputDirectory | Write-Host

# Build pdf files
docfx pdf en/docfx.json -o $outputDirectory | Write-Host
Build-EnglishPdf -SkipBuilding $SkipPdfBuilding

return $LastExitCode
}

function Build-EnglishPdf
{
param (
$SkipBuilding
)
if(!$SkipBuilding)
{
# Build pdf files
docfx pdf en/docfx.json -o $outputDirectory | Write-Host
}
}

function Build-NonEnglishDoc {
param (
$SelectedLanguage
Expand All @@ -219,12 +235,12 @@ function Build-NonEnglishDoc {
# Copy all files from en folder to the selected language folder, this way we can keep en files that are not translated
Copy-Item en/* -Recurse $langFolder -Force

# Get all translated files from the selected language folder
# Get all previously copied en files from the selected language folder
$files = Get-ChildItem "$langFolder/$($Settings.ManualFolderName)/*.md" -Recurse -Force

Write-Host "Start write files:"

# Mark files as not translated if they are not in the toc.md file
# Mark files as not translated if they are not a toc.md file
foreach ($file in $files)
{
if($file.ToString().Contains("toc.md")) {
Expand Down
1 change: 0 additions & 1 deletion en/community-resources/physics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@
* [Bepu physics integration](https://github.com/Nicogo1705/BepuPhysicIntegrationTest/tree/master)
* [Trigger Example](https://github.com/profan/XenkoByteSized#xenkobytesizedtriggerscene---doorscript)
* [Vehicle Script](https://github.com/profan/XenkoByteSized#xenkobytesizedvehiclescene---vehiclescript)
* [XenkoRotatingSun](https://github.com/SuavePirate/Xenko.RotatingSun) - Rotating Sun
165 changes: 165 additions & 0 deletions en/contributors/core-team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
# Core Team

The core team is a small group of volunteer developers, each with expertise in different areas of development. There are no full-time developers solely dedicated to Stride's advancement; instead, the engine progresses through voluntary contributions from both the core team and the [wider community](https://github.com/stride3d/stride?tab=readme-ov-file#contributors-). These individuals dedicate their spare time to enhancing and expanding the engine, driven by personal interest, passion for the project, and their specialized knowledge.

The core team is composed of members who make frequent contributions to the project, whether in code, documentation, or community management.

<table class="table table-striped table-sm">
<thead>
<tr>
<th>Discord</th>
<th>GitHub</th>
<th>Location</th>
<th>Focus / Expertise</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>xen2</strong>
<br><i>Lead developer of Stride</i>
<br><i class="small">(Original & Current)</i>
</td>
<td><a href="https://github.com/xen2">xen2</a></td>
<td>Japan</td>
<td>
<ul>
<li>Build</li>
<li>Release</li>
<li>Most engine areas</li>
<ul>
<li>Asset pipeline</li>
<li>Render pipelne</li>
<li>Shader system</li>
</ul>
</ul>
</td>
</tr>
<tr>
<td><strong>tebjan</strong></td>
<td><a href="https://github.com/tebjan">tebjan</a></td>
<td>Germany</td>
<td>
<ul>
<li>C# in general</li>
<li>Render pipeline</li>
<li>Graphics</li>
<li>Shaders</li>
</ul>
</td>
</tr>
<tr>
<td><strong>Eideren</strong></td>
<td><a href="https://github.com/Eideren">Eideren</a></td>
<td>Belgium</td>
<td>
<ul>
<li>C# in general</li>
<li>Shaders</li>
<li>Physics</li>
<li>Multithreading</li>
<li>Input/Gameplay</li>
<li>Math</li>
</ul>
</td>
</tr>
<tr>
<td><strong>Manio143</strong></td>
<td><a href="https://github.com/manio143">Manio143</a></td>
<td>Ireland</td>
<td>
<ul>
<li>Asset system</li>
<li>Porting Editor to Avalonia</li>
<li>Plugin system</li>
</ul>
</td>
</tr>
<tr>
<td><strong>Vašo</strong></td>
<td><a href="https://github.com/VaclavElias">VaclavElias</a></td>
<td>United Kingdom</td>
<td>
<ul>
<li>Website</li>
<li>Documenation</li>
<li>Stride Community Toolkit</li>
<li>C#</li>
</ul>
</td>
</tr>
<tr>
<td><strong>Simba</strong></td>
<td><a href="https://github.com/Doprez">Doprez</a></td>
<td>Canada</td>
<td>
<ul>
<li>Video Tutorials</li>
<li>C#</li>
</ul>
</td>
</tr>
<tr>
<td><strong>Joreyk</strong></td>
<td><a href="https://github.com/IXLLEGACYIXL">IXLLEGACYIXL</a></td>
<td>Germany</td>
<td>
<ul>
<li>Yaml Serializer Source Generator</li>
<li>Stride Diagnostics Analyzer</li>
<li>Overall source generators</li>
</ul>
</td>
</tr>
<tr>
<td><strong>Youness</strong></td>
<td><a href="https://github.com/ykafia">Youness KAFIA</a></td>
<td>France</td>
<td>
<ul>
<li>Shader system</li>
<li>ECS</li>
</ul>
</td>
</tr>
<tr>
<td><strong>Aggror</strong></td>
<td><a href="https://github.com/Aggror">Aggror</a></td>
<td>Netherlands</td>
<td>
<ul>
<li>Official video tutorials</li>
<li>Community meetings</li>
<li>Documentation</li>
<li>C#</li>
</ul>
</td>
</tr>
<tr>
<td><strong>Jkao</strong></td>
<td><a href="https://github.com/jklawreszuk">jklawreszuk</a></td>
<td>Poland</td>
<td>
<ul>
<li>Asset compiler</li>
<li>Metrics</li>
</ul>
</td>
</tr>
<tr>
<td>
<strong>kryptosfr</strong>
<br><i>Original developer of Stride</i>
</td>
<td><a href="https://github.com/Kryptos-FR">Kryptos-FR</a></td>
<td>France</td>
<td>
<ul>
<li>Game Studio</li>
<li>C#</li>
</ul>
</td>
</tr>
</tbody>
</table>

3 changes: 1 addition & 2 deletions en/contributors/engine/architecture/build-details.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Build details
This is a technical description what happens in our build and how it is organized. This covers mostly the build architecture of Stride itself.

* [Targets](../Targets) contains the MSBuild target files used by Games
* [sources/common/targets](../sources/common/targets) (generic) and [sources/targets](https://github.com/stride3d/stride/tree/master/sources/targets) (Stride-specific) contains the MSBuild target files used to build Stride itself.
* [sources/targets](https://github.com/stride3d/stride/tree/master/sources/targets) (Stride-specific) contains the MSBuild target files used to build Stride itself.

Since 3.1, we switched from our custom build system to the new csproj system with one nuget package per assembly.

Expand Down
11 changes: 10 additions & 1 deletion en/contributors/index.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,40 @@
# Ways to contribute

Stride is a non-profit, community-driven, free and open source project.
There are no full-time developers dedicated solely to Stride's advancement; instead, the engine progresses through the voluntary contributions of both the core team and the broader community.

There are no full-time developers dedicated solely to Stride's advancement; instead, the engine progresses through the voluntary contributions of both the [core team](core-team.md) and the broader community.

In order to thrive, Stride requires the help from other community members. There are various ways you can help:

### [Community activity](https://discord.gg/f6aerfE)🤝

To make Stride better, just use it and tell others about it in your blogs, videos, and events. Get involved in discussions on [Discord](https://discord.gg/f6aerfE) and [GitHub Discussion](https://github.com/stride3d/stride/discussions). Being a user and spreading the word is vital for our engine, as we don't have a big marketing budget and rely on the community to grow.

### [Make games](https://github.com/stride3d/stride/wiki/Community-Projects) 🕹️

The best way to promote Stride is by creating a cool demo or, even better, a full game. Having people see and play an actual game made with Stride is the most effective form of advertisement.

### [Donate](donate.md) 💸

We utilize Open Collective for fundraising. The funds collected are allocated towards bug bounties and compensating individuals contracted for paid work.

### [Submit bug reports](https://github.com/stride3d/stride/issues) 🐛

Making Stride more stable greatly improves usability and user satisfaction. So if you encounter a bug during development, please contribute by reporting it on [GitHub](https://github.com/stride3d/stride/issues).

### [PR reviews](https://github.com/stride3d/stride/pulls) 🔭

Contributing to Pull Requests (PRs) is excellent as it enables active participation without local builds. Reviewing and offering feedback in this collaborative process enhances code quality and maintains project standards, fostering a sense of community and knowledge sharing.

### [Contribute code](engine/index.md) 🤖

If you're passionate about C# and want to contribute by building features or fixing bugs in Stride, dive into the source code and get involved!
Have a look at the GitHub issues label [Good first issue](https://github.com/stride3d/stride/labels/good%20first%20issue) or funded [Open Collective projects](https://opencollective.com/stride3d/projects)

### [Contribute to Documentation](documentation/index.md) 🪶

Enhance the official documentation and tutorials by expanding the manual or creating textual/video guides. Your contributions will greatly improve accessibility and understanding for users.

### [Contribute to Website](website/index.md) 🌐

Enhance the official Stride website. Is design more your thing, or do you have an interesting blog post? It will all help us spread the word of Stride.
Loading

0 comments on commit fcbb21c

Please sign in to comment.