Skip to content

Commit 01d9fa6

Browse files
FejZaFejZa
committed
Reorganize
1 parent 1800727 commit 01d9fa6

17 files changed

+67
-66
lines changed

docs/features.md renamed to docs/00-introduction.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: features
3-
title: Features Overview
2+
id: introduction
3+
title: Introduction
4+
slug: /
45
---
56

67
Once Unity Tools for Azure DevOps has been installed to your organization, you'll have access to a set of

docs/about.md renamed to docs/01-getting-started/01-installation.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
11
---
2-
id: about
3-
title: About Unity Tools for Azure DevOps
4-
sidebar_label: About
5-
keywords:
6-
- Unity
7-
- Azure
8-
- DevOps
9-
- Pipelines
10-
- GitHub
11-
slug: /
2+
id: installation
3+
title: Installation
4+
sidebar_label: Installation
125
---
136

7+
# Install the extension to your DevOps organization
8+
149
:::note
1510

1611
This documentation assumes you have some knowledge of setting up pipelines using Azure DevOps/Pipelines. If you have questions beyond the scope of this documentation check out this [guide](https://docs.microsoft.com/en-us/azure/devops/pipelines/create-first-pipeline?view=azure-devops&tabs=java%2Ctfs-2018-2%2Cbrowser) to get started with your first Azure Pipeline or join our [Discord](https://discord.gg/RpHSpxkEP6) to find help.
@@ -29,11 +24,11 @@ The extension is published to the Visual Studio Marketplace and can be installed
2924

3025
1. Open the extension [Unity Tools for Azure DevOps](https://marketplace.visualstudio.com/items?itemName=DinomiteStudios.64e90d50-a9c0-11e8-a356-d3eab7857116) in the marketplace and select `Get it free` to start the installation process.
3126

32-
![Extension in Marketplace](../static/img/vs-marketplace-get-extension.png)
27+
![Extension in Marketplace](../../static/img/vs-marketplace-get-extension.png)
3328

3429
2. Select the Azure DevOps organization you want to install the extension to and proceed by selecting `Install`. *(You may also download the extension if you are using Azure DevOps Server).*
3530

36-
![Install to organization](../static/img/vs-marketplace-install.png)
31+
![Install to organization](../../static/img/vs-marketplace-install.png)
3732

3833
3. The extension is now installed and you are ready to create your first Unity pipeline.
3934

‎docs/01-getting-started/02-unity-support.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
id: unity-support
3+
title: Supported Unity Versions
4+
sidebar_label: Supported Unity Versions
5+
---

‎docs/01-getting-started/03-agent-support.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
id: agent-support
3+
title: Supported Agents
4+
sidebar_label: Supported Agents
5+
---

‎docs/01-getting-started/_category_.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"label": "Getting Started",
3+
"link": {
4+
"type": "generated-index",
5+
"description": "Get started using Unity Tools for Azure DevOps."
6+
}
7+
}

‎docs/02-tasks/_category_.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"label": "Tasks",
3+
"link": {
4+
"type": "generated-index",
5+
"description": "Once installed, you'll have the following Unity related tasks available for use in your pipeline definitions."
6+
}
7+
}

docs/unity-activate-license-task.md renamed to docs/02-tasks/unity-activate-license-task.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
id: unity-activate-license-task
33
title: Unity Activate License
4+
sidebar_label: Unity Activate License
45
---
56

67
## About
@@ -131,12 +132,12 @@ steps:
131132
132133
The classic (visual) editor for Azure Pipelines provides input fields for configuring the task. In the simple example below, we set variables, which we previously defined, for the `username`, `password` and `serial` inputs. For `Unity editors location` we tell the task to use the default Unity Hub installation path to lookup installed Unity editor versions on the agent running our pipeline. We are also leaving the `Unity project path` field empty, since we know our Unity project is in the repository root. We are also assigning a `Reference name` to the task, so we can use it to refernce the output variables in the variables list in other tasks of the pipeline. E.g. to get the value of the `logsOutputPath` output variable and insert it into any other input field of a task we can then use `$(unityactivation.logsOutputPath)`.
133134

134-
![Classic Pipeline Designer Task Configuration](../static/img/unity-activate-license-task/unity-activate-license-classic.png)
135+
![Classic Pipeline Designer Task Configuration](../../static/img/unity-activate-license-task/unity-activate-license-classic.png)
135136

136137
---
137138

138139
## Log
139140

140141
When run and successful the task will provide log output similar to this:
141142

142-
![Task Log](../static/img/unity-activate-license-task/unity-activate-license-log.png)
143+
![Task Log](../../static/img/unity-activate-license-task/unity-activate-license-log.png)

docs/unity-build-task.md renamed to docs/02-tasks/unity-build-task.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
id: unity-build-task
33
title: Unity Build
4+
sidebar_label: Unity Build
45
---
56

67
## About
@@ -196,12 +197,12 @@ steps:
196197
197198
The classic (visual) editor for Azure Pipelines provides input fields for configuring the task. In the simple example below, we set `Build target` to `Standalone (agent-based)`, that means if our pipeline runs on a Windows agent we get a Windows built and if on a mac we'll get a macOS build. We are also assigning a `Reference name` to the task, so we can use it to refernce the output variables in the variables list in other tasks of the pipeline. E.g. to get the value of the `logsOutputPath` output variable and insert it into any other input field of a task we can then use `$(unitybuild.logsOutputPath)`. Everything else we are leaving at the defaults.
198199

199-
![Classic Pipeline Designer Task Configuration](../static/img/unity-build-task/unity-build-classic.png)
200+
![Classic Pipeline Designer Task Configuration](../../static/img/unity-build-task/unity-build-classic.png)
200201

201202
---
202203

203204
## Log
204205

205206
When run and successful the task will provide log output similar to this:
206207

207-
![Task Log](../static/img/unity-build-task/unity-build-log.png)
208+
![Task Log](../../static/img/unity-build-task/unity-build-log.png)

docs/unity-cmd-task.md renamed to docs/02-tasks/unity-cmd-task.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
id: unity-cmd-task
33
title: Unity CMD
4+
sidebar_label: Unity CMD
45
---
56

67
## About
@@ -107,12 +108,12 @@ steps:
107108
108109
The classic (visual) editor for Azure Pipelines provides input fields for configuring the task. In the simple example below, we set `Unity editors location` to use the default Unity Hub installation path to lookup installed Unity editor versions on the agent running our pipeline. We are also leaving the `Unity project path` field empty, since we know our Unity project is in the repository root. For `Command line arguments` we specify that Unity should target the `standalone` platform and execute our custom build script `MyBuildTools.BuildProject` to perform the build. We are also assigning a `Reference name` to the task, so we can use it to refernce the output variables in the variables list in other tasks of the pipeline. E.g. to get the value of the `logsOutputPath` output variable and insert it into any other input field of a task we can then use `$(unitycmd.logsOutputPath)`.
109110

110-
![Classic Pipeline Designer Task Configuration](../static/img/unity-cmd-task/unity-cmd-classic.png)
111+
![Classic Pipeline Designer Task Configuration](../../static/img/unity-cmd-task/unity-cmd-classic.png)
111112

112113
---
113114

114115
## Log
115116

116117
When run and successful the task will provide log output similar to this:
117118

118-
![Task Log](../static/img/unity-cmd-task/unity-cmd-log.png)
119+
![Task Log](../../static/img/unity-cmd-task/unity-cmd-log.png)

‎docs/02-tasks/unity-create-project-task.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
id: unity-create-project-task
3+
title: Unity Create Project
4+
sidebar_label: Unity Create Project
5+
---

0 commit comments

Comments
 (0)