You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Welcome to the Stride Docs repository. This repository contains all the source f
11
11
12
12
## 🚀 Getting Started
13
13
14
-
All the information you need to get started with Stride Docs development can be found in the 📚 [Stride Docs Wiki](https://github.com/stride3d/stride-docs/wiki).
14
+
All the information you need to get started with Stride Docs development can be found in the 📚 [Stride Docs](https://doc.stride3d.net/latest/en/contributors/documentation/index.html).
Copy file name to clipboardexpand all lines: en/contributors/documentation/content.md
+1-13
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,7 @@
1
-
# Documentation Contents
2
-
1
+
# Documentation content
3
2
-[Content Updates](#content-updates)
4
3
-[Small Updates](#small-updates)
5
4
-[Major Updates](#major-updates)
6
-
-[Updating Wiki](#updating-wiki)
7
5
-[Manual](#manual)
8
6
-[Creating New Page](#creating-new-manual-page)
9
7
-[Tutorial](#tutorial)
@@ -66,16 +64,6 @@ You would start with the local development environment, which is described in th
66
64
67
65
Then you would make your changes and test them locally. Once you are happy with the result, you can create a pull request to merge your changes into the `master` branch.
68
66
69
-
## Updating Wiki
70
-
71
-
While wiki pages can be updated directly in the GitHub web interface, this feature is restricted only to contributors who can edit the wiki directly. We have decided to move our wiki pages to a regular folder in this repository called `wiki`, allowing us to use the same process as we do for the website content. If any changes are made directly on the wiki pages, they will be overwritten by the next wiki deployment.
72
-
73
-
Wiki pages are deployed through a separate GitHub action, `stride-docs-wiki.yml`, which is triggered by updates in the `wiki` folder or can be triggered manually. The `wiki` folder is ignored by the docfx build process, ensuring that the wiki pages are not deployed to the website. Additionally, any pushes to the `wiki` folder will not trigger the website deployment.
74
-
75
-
You can update the wiki pages as any other content pages, by following the steps in the [Small Updates](#small-updates) section.
76
-
77
-
⚠️**Important:** If you are updating any headers in the wiki pages, please make sure to update the *Table of Contents* at the top of the page, [Home](Home) page and `_Sidebar.md`. Also, you might need to search for all the links to the updated header and update them as well.
78
-
79
67
# Manual
80
68
81
69
These pages contain information about how to use Stride, an open-source C# game engine.
Copy file name to clipboardexpand all lines: en/contributors/documentation/deployment.md
+2-23
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,9 @@
1
-
# Table of Contents
2
-
1
+
# Deployment
3
2
We tested five different deployment methods and chose Azure Web Apps IIS ASP.NET 4.8.
4
3
5
4
-[GitHub Pages](#github-pages)
6
5
-[Azure Web Apps](#azure-web-apps)
7
6
-[Deploying with .NET Framework](#deploying-with-net-framework)
8
-
-[Deployment To Wiki](#deployment-to-wiki)
9
7
10
8
# GitHub Pages
11
9
@@ -50,26 +48,7 @@ The GitHub action `stride-website-staging-azure` builds the website and deploys
50
48
51
49
[Step-by-Step Deployment Guide for Azure Web Apps (Windows) with IIS and Stride Website](Deployment-Azure).
52
50
53
-
# Deployment To Wiki
54
-
55
-
While the GitHub wiki offers a convenient way to document a project, it has some drawbacks, such as not being part of the repository by default and restricting edits to collaborators. To address these issues and allow community editing, we have implemented an alternative approach.
56
-
57
-
We created a `wiki` folder within the repository, which contains all wiki pages. The GitHub action `stride-web-wiki.yml` deploys the `wiki` folder to the GitHub wiki.
58
-
59
-
The GitHub action `stride-web-wiki.yml` is triggered when:
60
-
61
-
1. A push is made to the `master` branch of the `stride-website` repository
62
-
1. The action is manually triggered
63
-
64
-
You can manually trigger the action by navigating to the **Actions** tab and clicking the **Run workflow** button.
65
-
66
-
This GitHub action only monitors changes to the `wiki` folder. Any modifications made to the `wiki` folder will be deployed to the GitHub wiki. Note that changes to the `wiki` folder will not trigger other GitHub actions.
67
-
68
-
We use the [Wiki Page Creator GitHub Action](https://github.com/marketplace/actions/wiki-page-creator-action) to deploy the `wiki` folder to the GitHub wiki.
69
-
70
-
**Note**: ⚠️ A GitHub personal access token (GH_PAT) is required for authentication. This token is stored as a secret in the repository settings.⚠️
Copy file name to clipboardexpand all lines: en/contributors/documentation/docfx.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,4 @@
1
+
# DocFX
1
2
[docfx](https://www.11ty.dev/) is a static site generator that uses JavaScript as its templating language. It is a very powerful tool that allows us to create a website with a lot of flexibility and customization. It is also very easy to use and learn. This section will cover the basics of Eleventy configuration on the Stride website. Creating and updating the content is described in our [Content](Content) section.
2
3
3
4
We used to use **Jekyll** as our static site generator, but we decided to switch to Eleventy because of its flexibility and ease of use. We also wanted to use a tool that is more widely used and supported, which is why we decided to switch to Eleventy.
@@ -80,7 +81,6 @@ The folder structure is crucial for Eleventy, as it determines the output of the
80
81
-`/posts` - Blog posts
81
82
-`/posts/2014-2021` - Old blog posts which are merged to the same output folder as `/posts`
82
83
- this folder is only for convenience to easily access new posts
83
-
-`/wiki` - Excluded from build process, used only for wiki deployment
Copy file name to clipboardexpand all lines: en/contributors/documentation/index.md
+2-4
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
-
This documentation serves as a comprehensive guide to help you navigate and contribute to the **Stride Docs** website.
1
+
# Contributing to documentation
2
+
This documentation serves as a comprehensive guide to help you navigate and contribute to the **Stride Docs** website.
2
3
3
4
If you're looking to make minor changes, such as adding or updating a manual, tutorial or page, or fixing a typo, feel free to jump straight to the [Content Updates](content#content-updates) section.
4
5
@@ -11,7 +12,6 @@ Here are the technologies we use to build our website:
Copy file name to clipboardexpand all lines: en/contributors/documentation/installation.md
+1
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,4 @@
1
+
# Local installation
1
2
This guide will walk you through the steps to install the Stride Docs website on your local machine for development purposes. Although we use the Windows operating system for development, the steps should be similar for other operating systems.
2
3
3
4
[Minor updates](Content#small-updates) can be made directly on GitHub. However, for [more significant updates](Content#major-updates) that affect multiple pages, we recommend using a local development environment so you can see the impact of your changes beforehand. This is because we use the **docfx** static site generator, and in some cases, all pages need to be regenerated. This approach helps you assess your changes before submitting a pull request.
Copy file name to clipboardexpand all lines: en/contributors/engine/building-source-windows-other-ide.md
+1-3
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,4 @@
1
-
2
-
## Build Stride without Visual Studio
3
-
1
+
## Build Stride without Visual Studio
4
2
1. Install [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe) with the same prerequisites listed [here](building-source-windows.md)
5
3
2. Add MSBuild's directory to your system's *PATH* (ex: `C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\MSBuild\Current\Bin`)
6
4
3. Open a command prompt, point it to a directory and clone Stride to it: `git lfs clone https://github.com/stride3d/stride.git`
Copy file name to clipboardexpand all lines: en/contributors/engine/building-source-windows.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ Here are the steps to build Stride with Visual Studio. If you do not have or wan
34
34
Do note that test solutions might fail but it should not prevent you from building `Stride.GameStudio`.
35
35
36
36
## Other IDEs
37
-
You are not required to use Visual Studio to build the Stride engine with Visual Studio. You can also build entirely from command line or other IDE's such as [Rideror Visual Studio Code](building-source-windows-other-ide.md)
37
+
You are not required to use Visual Studio to build the Stride engine with Visual Studio. You can also build entirely from command line or other IDE's such as [Rider or Visual Studio Code](building-source-windows-other-ide.md)
Copy file name to clipboardexpand all lines: en/contributors/ways-to-contribute.md
+6-5
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,15 @@
1
1
# Ways to contribute
2
-
Stride 3d is a non-profit, community-driven free and open source project.
2
+
3
+
Stride 3d is a non-profit, community-driven, free and open source project.
3
4
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.
4
5
5
6
In order to thrive, Stride requires the help from other community members. There are various ways you can help:
To make Stride3d 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.
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.
13
14
14
15
@@ -24,12 +25,12 @@ Making Stride more stable greatly improves usability and user satisfaction. So i
24
25
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.
25
26
26
27
27
-
### [Contribute code](engine/index.md)
28
+
### [Contribute code](engine/index.md)🤖
28
29
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!
29
30
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)
30
31
31
32
### [Contribute to Documentation](documentation/index.md) 🪶
32
33
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.
33
34
34
-
### [Contribute to Website](website/index.md)🪶
35
+
### [Contribute to Website](website/index.md)🌐
35
36
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.
@@ -75,16 +73,6 @@ You would start with the local development environment, which is described in th
75
73
76
74
Then you would make your changes and test them locally. Once you are happy with the result, you can create a pull request to merge your changes into the `master` branch.
77
75
78
-
## Updating Wiki
79
-
80
-
While wiki pages can be updated directly in the GitHub web interface, this feature is restricted only to contributors who can edit the wiki directly. We have decided to move our wiki pages to a regular folder in this repository called [wiki](https://github.com/stride3d/stride-website/tree/master/wiki), allowing us to use the same process as we do for the website content. If any changes are made directly on the wiki pages, they will be overwritten by the next wiki deployment.
81
-
82
-
Wiki pages are deployed through a separate GitHub action, `stride-web-wiki.yml`, which is triggered by updates in the `wiki` folder or can be triggered manually. The `wiki` folder is ignored by the Eleventy build process, ensuring that the wiki pages are not deployed to the website. Additionally, any pushes to the `wiki` folder will not trigger the website deployment.
83
-
84
-
You can update the wiki pages as any other content pages, by following the steps in the [Small Updates](#small-updates) section.
85
-
86
-
⚠️**Important:** If you are updating any headers in the wiki pages, please make sure to update the *Table of Contents* at the top of the page, [Home](https://github.com/stride3d/stride-website/blob/master/wiki/Home.md) page and [_Sidebar.md](https://github.com/stride3d/stride-website/blob/master/wiki/_Sidebar.md). Also, you might need to search for all the links to the updated header and update them as well.
87
-
88
76
# Creating New Post
89
77
90
78
To create a new blog post, you can follow one of these methods:
Copy file name to clipboardexpand all lines: en/contributors/website/deployment.md
+1-2
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,4 @@
1
-
# Table of Contents
2
-
1
+
# Website deployment
3
2
We tested five different deployment methods (GitHub Pages, Azure Web App Windows/Linux IIS/Kestrel, Azure Static Web Apps) and chose to continue with the existing Azure Web Apps IIS ASP.NET 4.8 infrastructure.
Copy file name to clipboardexpand all lines: en/contributors/website/index.md
+2-4
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
-
# Welcome to the Stride Website Wiki.
2
-
3
-
This wiki serves as a comprehensive guide to help you navigate and contribute to the **Stride website**.
1
+
# Contributing to the Stride website
2
+
This documentation serves as a comprehensive guide to help you navigate and contribute to the **Stride website**.
4
3
5
4
If you're looking to make minor changes, such as adding or updating a post or page, or fixing a typo, you can jump straight to the [Content Updates](content#content-updates) section.
6
5
@@ -13,7 +12,6 @@ Technologies we use to build our website:
13
12
- Mainly [Liquid](https://shopify.github.io/liquid/) and a bit Nunjucks (template engines)
14
13
- Bootstrap
15
14
- Font Awesome
16
-
- GitHub Wiki
17
15
- HTML, JavaScript, CSS, SCSS, and JSON
18
16
- GitHub Actions (CI/CD) - Don't worry, this is already set up, you don't need to worry about it.
Copy file name to clipboardexpand all lines: en/contributors/website/installation.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Installation
1
+
# Local installation
2
2
This guide will walk you through the steps to install the Stride website on your local machine for development purposes. Although we use the Windows operating system for development, the steps should be similar for other operating systems.
3
3
4
4
[Minor updates](Content#small-updates) can be made directly on GitHub. However, for [more significant updates](Content#major-updates) that affect multiple pages, we recommend using a local development environment so you can see the impact of your changes beforehand. This is because we use the **Eleventy** static site generator, and in some cases, all pages need to be regenerated. This approach helps you assess your changes before submitting a pull request.
0 commit comments