Skip to content

Commit d05e50f

Browse files
keveleighkeveleigh
authored
Begin migration of dev docs to GitHub (#1082)
* Add package references to the README * Fix some links in CONTRIBUTING.md * Fix some links in GOVERNANCE.md * Add missing README files And add meta files * Add gh-pages pipeline * Try nested packages * Update README copying * Update pack-upm.ps1 * Manually add the CHANGELOG line via script * Convert GitHub admonitions to just-the-docs syntax * Generate index.md from the project root readme * Rename Images -> images * Nest the files * Initial drop * Add front matter * Add nav_order metadata And remove descriptions, as they were mostly duplicative with the title * Try parsing the rest of the markdown files * $_.Directory -> $_.DirectoryName * De-dupe READMEs * README style and format updates * Convert GitHub admonitions to just-the-docs syntax * Remove the ~ from the Documentation~ folder name * Update pages.yml * Update other pipelines * Force file/dir creation and skip data package * Update table formatting * Add logo * Squash the getting-started folder * Update some learn.microsoft.com to point to this repo now * Try jekyll-relative-links * Update some file headers * Include contributions folder De-dupe contribution guidelines * Update copyright year * Update image cropping * De-dupe root readme * Update setup, configuration, and deployment docs a * Add Android XR docs * Rework the "getting started" section * Rework MRFT references * More information and guidance around package import * Update gh-pages.yml
1 parent c105fef commit d05e50f

147 files changed

Lines changed: 1810 additions & 192 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/gh-pages.yml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: Deploy docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
paths:
7+
[
8+
"docs/**",
9+
"**/README.md",
10+
"**/CHANGELOG.md",
11+
"Pipelines/Scripts/prepare-pages.ps1",
12+
]
13+
14+
# Allows you to run this workflow manually from the Actions tab
15+
workflow_dispatch:
16+
17+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
18+
permissions:
19+
contents: read
20+
pages: write
21+
id-token: write
22+
23+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
24+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
25+
concurrency:
26+
group: "pages"
27+
cancel-in-progress: false
28+
29+
jobs:
30+
# Build job
31+
build:
32+
runs-on: ubuntu-latest
33+
defaults:
34+
run:
35+
working-directory: docs
36+
steps:
37+
- name: Checkout
38+
uses: actions/checkout@v5
39+
- name: Copy documentation files
40+
shell: pwsh
41+
run: ${{ github.workspace }}/Pipelines/Scripts/prepare-pages.ps1 -ProjectRoot ${{ github.workspace }}
42+
- name: Setup Ruby
43+
# https://github.com/ruby/setup-ruby/releases/tag/v1.207.0
44+
uses: ruby/setup-ruby@4a9ddd6f338a97768b8006bf671dfbad383215f4
45+
with:
46+
ruby-version: "3.3" # Not needed with a .ruby-version file
47+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
48+
cache-version: 0 # Increment this number if you need to re-download cached gems
49+
working-directory: "${{ github.workspace }}/docs"
50+
- name: Setup Pages
51+
id: pages
52+
uses: actions/configure-pages@v5
53+
- name: Build with Jekyll
54+
# Outputs to the './_site' directory by default
55+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
56+
env:
57+
JEKYLL_ENV: production
58+
- name: Upload artifact
59+
# Automatically uploads an artifact from the './_site' directory by default
60+
uses: actions/upload-pages-artifact@v3
61+
with:
62+
path: docs/_site/
63+
64+
# Deployment job
65+
deploy:
66+
environment:
67+
name: github-pages
68+
url: ${{ steps.deployment.outputs.page_url }}
69+
runs-on: ubuntu-latest
70+
needs: build
71+
steps:
72+
- name: Deploy to GitHub Pages
73+
id: deployment
74+
uses: actions/deploy-pages@v4

‎.github/workflows/pr_labeler.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
name: "PR Labeling"
1+
name: PR Labeling
2+
23
on:
34
pull_request_target:
45
types: [opened, closed, synchronize, reopened, edited, ready_for_review]
5-
6+
67
permissions:
78
contents: read
89
pull-requests: write

‎.github/workflows/validation_mrtk3.yaml‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@ on:
44
push:
55
branches:
66
- main
7-
- 'feature/*'
7+
- "feature/*"
88
pull_request:
99

1010
jobs:
1111
validation:
1212
runs-on: ubuntu-latest
1313

1414
steps:
15-
- uses: actions/checkout@v6
15+
- uses: actions/checkout@v6
1616

17-
- name: Get Pull Request changes
18-
if: github.event_name == 'pull_request'
19-
run: |
20-
${{ github.workspace }}/Pipelines/Scripts/gitchanges.ps1 -TargetBranch '${{ github.base_ref }}' -OutputFile '${{ runner.temp }}/build/changed_files.txt' -RepoRoot '${{ github.workspace }}'
21-
shell: pwsh
17+
- name: Get Pull Request changes
18+
if: github.event_name == 'pull_request'
19+
run: |
20+
${{ github.workspace }}/Pipelines/Scripts/gitchanges.ps1 -TargetBranch '${{ github.base_ref }}' -OutputFile '${{ runner.temp }}/build/changed_files.txt' -RepoRoot '${{ github.workspace }}'
21+
shell: pwsh
2222

23-
- name: Scoped code validation
24-
if: github.event_name == 'pull_request'
25-
run: |
26-
${{ github.workspace }}/Pipelines/Scripts/validatecode.ps1 -Directory '${{ github.workspace }}' -ChangesFile '${{ runner.temp }}/build/changed_files.txt'
27-
shell: pwsh
23+
- name: Scoped code validation
24+
if: github.event_name == 'pull_request'
25+
run: |
26+
${{ github.workspace }}/Pipelines/Scripts/validatecode.ps1 -Directory '${{ github.workspace }}' -ChangesFile '${{ runner.temp }}/build/changed_files.txt'
27+
shell: pwsh
2828

29-
- name: Global code validation
30-
if: github.event_name == 'push'
31-
run: |
32-
${{ github.workspace }}/Pipelines/Scripts/validatecode.ps1 -Directory '${{ github.workspace }}'
33-
shell: pwsh
29+
- name: Global code validation
30+
if: github.event_name == 'push'
31+
run: |
32+
${{ github.workspace }}/Pipelines/Scripts/validatecode.ps1 -Directory '${{ github.workspace }}'
33+
shell: pwsh

‎CODE_OF_CONDUCT.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Mixed Reality Toolkit Code of Conduct
22

3-
Contributors of this project must abide by the Mixed Reality Toolkit Organization's [code of conduct](https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/CODE-OF-CONDUCT.md).
3+
Contributors of this project must abide by the Mixed Reality Toolkit Organization's [code of conduct](https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/CODE-OF-CONDUCT.md).

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,17 @@ This project welcomes contributions, suggestions, and feedback. All contribution
66

77
Contributors must abide by the Mixed Reality Toolkit Organization's [code of conduct](https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/CODE-OF-CONDUCT.md), [trademark policy](https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/TRADEMARKS.md), and observe the following procedures:
88

9-
* [Project Tenets](contributions/project-tenets.md)
10-
* [Code Contributions](contributions/code-contributions.md)
11-
* [Opening and Assessing Issues](contributions/opening-and-assessing-issues.md)
12-
* [Approving Pull Requests](contributions/merging-pull-requests.md)
13-
* [Versioning and Releases](contributions/versioning-and-releases.md)
9+
* [Project tenets](./contributions/project-tenets.md)
10+
* [Code contributions](./contributions/code-contributions.md)
11+
* [Opening and assessing issues](./contributions/opening-and-assessing-issues.md)
12+
* [Approving pull requests](./contributions/merging-pull-requests.md)
13+
* [Versioning and releases](./contributions/versioning-and-releases.md)
1414

1515
### GitHub roles
1616

17-
Project roles are assigned by Maintainers via procedures outlined in the [GOVERNANCE.md](../GOVERNANCE.md) fileContributors may have one for the following roles:
17+
Project roles are assigned by Maintainers via procedures outlined in the [Governance document](./GOVERNANCE.md).
18+
19+
Contributors may have one for the following roles:
1820

1921
* **Read** Read and clone repositories. Open and comment on issues and pull requests.
2022
* **Triage** Read permissions plus manage issues and pull requests.
@@ -56,7 +58,7 @@ Maintainers have the **maintain** role, which grants write permissions plus mana
5658
* Should have participated in multiple code reviews of other PR’s, including those of other Maintainers and Contributors.
5759
* Should be active on the Project's community forums.
5860

59-
Maintainers are added and removed via procedures outlined in the [GOVERNANCE.md](./GOVERNANCE.md) file.
61+
Maintainers are added and removed via procedures outlined in the [Governance document](./GOVERNANCE.md).
6062

6163
---
6264
Part of MVG-0.1-beta.

‎GOVERNANCE.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Governance Policy
22

3-
This document provides the governance policy for the Mixed Reality Toolkit for Unity Project. Maintainers agree to this policy and to abide by all Project polices, including the [code of conduct](../org-docs/CODE-OF-CONDUCT.md), [trademark policy](../org-docs/TRADEMARKS.md), and [antitrust policy](../org-docs/ANTITRUST.md) by adding their name to the [MAINTAINERS.md](./MAINTAINERS.md) file.
3+
This document provides the governance policy for the Mixed Reality Toolkit for Unity Project. Maintainers agree to this policy and to abide by all Project polices, including the [code of conduct](https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/CODE-OF-CONDUCT.md), [trademark policy](https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/TRADEMARKS.md), and [antitrust policy](https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/ANTITRUST.md) by adding their name to the [MAINTAINERS.md](./MAINTAINERS.md) file.
44

5-
All projects under the Mixed Reality Toolkit organization are governed by the Steering Committee. The Steering Committee is responsible for all technical oversight, project approval and oversight, policy oversight, and trademark management for the Organization. To learn more about the Steering Committee, visit this link: https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/CHARTER.md
5+
All projects under the Mixed Reality Toolkit organization are governed by the Steering Committee. The Steering Committee is responsible for all technical oversight, project approval and oversight, policy oversight, and trademark management for the Organization. To learn more about the Steering Committee, visit this link: <https://github.com/MixedRealityToolkit/MixedRealityToolkit-MVG/blob/main/org-docs/CHARTER.md>
66

77
## 1. Roles
88

‎LICENSE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 3-Clause License
22

3-
Copyright (c) 2023, Mixed Reality Toolkit Contributors
3+
Copyright (c) 2025, Mixed Reality Toolkit Contributors
44

55
Redistribution and use in source and binary forms, with or without
66
modification, are permitted provided that the following conditions are met:

‎Pipelines/Scripts/pack-upm.ps1‎

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ try {
4949
# Update package versions
5050
. $PSScriptRoot\update-versions.ps1 -PackagesRoot $ProjectRoot -PrereleaseTag $PrereleaseTag -Revision $Revision -BuildNumber $BuildNumber
5151

52-
# Loop through package directories and copy documentation
52+
# Loop through package directories, copy documentation, and package
5353
Get-ChildItem -Path $ProjectRoot/*/package.json | ForEach-Object {
5454
$packageName = Select-String -Pattern "org\.mixedrealitytoolkit\.\w+(\.\w+)*" -Path $_ | Select-Object -First 1
5555

@@ -58,7 +58,7 @@ try {
5858
}
5959

6060
$packageName = $packageName.Matches[0].Value
61-
$packagePath = $_.Directory
61+
$packagePath = $_.DirectoryName
6262
$docFolder = "$packagePath/Documentation~"
6363

6464
Write-Host ""
@@ -73,28 +73,15 @@ try {
7373
else {
7474
Copy-Item -Path "$ProjectRoot/Pipelines/UPM/Documentation~" -Destination $docFolder -Recurse
7575
}
76-
}
77-
78-
# Package the package directories
79-
Get-ChildItem -Path $ProjectRoot/*/package.json | ForEach-Object {
80-
$currentPackageName = Select-String -Pattern "org\.mixedrealitytoolkit\.\w+(\.\w+)*" -Path $_ | Select-Object -First 1
81-
82-
if (-not $currentPackageName) {
83-
return # this is not an MRTK package, so skip
84-
}
8576

8677
Write-Host ""
8778
Write-Host -ForegroundColor Green "======================================="
8879
Write-Host -ForegroundColor Green "Packing Package"
8980
Write-Host -ForegroundColor Green "======================================="
90-
Write-Host "Package name: $currentPackageName"
81+
Write-Host "Package name: $packageName"
9182

92-
$currentPackageName = $currentPackageName.Matches[0].Value
9383
$packageFriendlyName = (Select-String -Pattern "`"displayName`": `"(.+)`"" -Path $_ | Select-Object -First 1).Matches.Groups[1].Value
9484

95-
$packagePath = $_.Directory
96-
$docFolder = "$packagePath/Documentation~"
97-
9885
# build the package
9986
npm pack $packagePath
10087

0 commit comments

Comments
 (0)