Skip to content

Commit 4ca6b21

Browse files
KebooKeboo
committed
Refactoring getting started doc to use tabs
Restructures the getting started to collapse everything into a language specific page.
1 parent e50cd18 commit 4ca6b21

19 files changed

+466
-652
lines changed

‎docs/getting-started/content/_build-release.mdx‎

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,22 @@
11
import Admonition from '@theme/Admonition';
22

3-
<FancyStep step={props.step} noline={true}>
4-
<details>
5-
<summary>
6-
<strong>Build Velopack release!</strong>
7-
</summary>
3+
You are now ready to build a Velopack release for your application.
84

9-
You are now ready to build a Velopack release for your application.
5+
The `--packId` can be any unique application identifier that you wish to use. Because this must be unique across all applications,
6+
we recommend including your company name: `<CompanyName>.<AppName>`.
107

11-
The `--packId` can be any unique application identifier that you wish to use. Because this must be unique across all applications,
12-
we recommend including your company name: `<CompanyName>.<AppName>`.
8+
The `--mainExe` option is only required if your executable name is different than the `--packId` of your application.
139

14-
The `--mainExe` option is only required if your executable name is different than the `--packId` of your application.
10+
See the [CLI reference](/reference/cli/) for more details on the available options.
1511

16-
See the [CLI reference](/reference/cli/) for more details on the available options.
12+
```cmd
13+
vpk pack --packId YourAppId --packVersion 1.0.0 --packDir .\publish --mainExe yourMainApp.exe
14+
```
1715

18-
```cmd
19-
vpk pack --packId YourAppId --packVersion 1.0.0 --packDir .\publish --mainExe yourMainApp.exe
20-
```
21-
22-
{props.includeWarningTip && (
23-
<Admonition type="tip">
24-
<code>vpk</code> will produce the a warning saying that the <code>VelopackApp.Run()</code> was
25-
not found in the entry point of your application.
26-
This is expected, and the warning can be safely ignored for this type of application.
27-
</Admonition>
28-
)}
29-
</details>
30-
</FancyStep>
16+
{props.includeWarningTip && (
17+
<Admonition type="tip">
18+
<code>vpk</code> will produce the a warning saying that the <code>VelopackApp.Run()</code> was
19+
not found in the entry point of your application.
20+
This is expected, and the warning can be safely ignored for this type of application.
21+
</Admonition>
22+
)}

‎docs/getting-started/content/_csharp-main.mdx‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎docs/getting-started/content/_csharp-publish.mdx‎

Lines changed: 44 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,46 @@
11
import Admonition from '@theme/Admonition';
22

3-
<FancyStep step={6}>
4-
<details>
5-
<summary>
6-
<strong>Publish App</strong>
7-
</summary>
8-
9-
Before building a Velopack release, you must first build your application and publish it to a directory.
10-
11-
For simplicity, we recommend publishing it as a [self-contained application](https://learn.microsoft.com/en-us/dotnet/core/deploying/#publish-self-contained).
12-
13-
{!props.showMultipleTfmSuggestion && (
14-
<>
15-
<p>
16-
<code className="language-bash">
17-
dotnet publish yourApp.csproj -c Release --self-contained -r win-x64 -o .\publish
18-
</code>
19-
</p>
20-
</>
21-
)}
22-
23-
24-
{props.showMultipleTfmSuggestion && (
25-
<>
26-
<p>
27-
<code className="language-cmd">
28-
dotnet publish -f net8.0-desktop -p:Version=1.0.0 -o .\publish
29-
</code>
30-
</p>
31-
<p>
32-
This will create the artifacts to be installed inside of the <code>publish</code> directory. If you are targeting multiple platforms this process will need to be repeated for each of those platforms replacing the <code>-f</code> option with the appropriate target framework moniker (TFM) for each platform, such as <code>net8.0-windows</code> or <code>net8.0-maccatalyst</code>.
33-
</p>
34-
</>
35-
)}
36-
37-
{props.suffix && (
38-
<p>
39-
<span dangerouslySetInnerHTML={{ __html: props.suffix }} />
40-
</p>
41-
)}
42-
43-
<Admonition type="tip">
44-
Starting with .NET 7, the `-o`/`--output` option [can no longer be used with a solution file](https://learn.microsoft.com/en-us/dotnet/core/compatibility/sdk/7.0/solution-level-output-no-longer-valid?WT.mc_id=DT-MVP-5003472).
45-
46-
Starting with .NET 8 and later, the `dotnet publish` command defaults to the Release configuration, so you can omit the `-c Release` option.
47-
For more details see https://learn.microsoft.com/en-us/dotnet/core/compatibility/sdk/8.0/dotnet-publish-config.
48-
49-
If you execute the dotnet publish command from within the same directory as the .csproj file, you can omit the project argument. You can find more details on the [dotnet publish documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-publish?WT.mc_id=DT-MVP-5003472#arguments).
50-
</Admonition>
51-
52-
</details>
53-
</FancyStep>
3+
Before building a Velopack release, you must first build your application and publish it to a directory.
4+
5+
6+
{!props.showMultipleTfmSuggestion && (
7+
<>
8+
<p>
9+
For simplicity, we recommend publishing it as a <a href="https://learn.microsoft.com/dotnet/core/deploying/#publish-self-contained">self-contained application</a>.
10+
</p>
11+
<p>
12+
<code className="language-bash">
13+
dotnet publish yourApp.csproj -c Release --self-contained -r win-x64 -o .\publish
14+
</code>
15+
</p>
16+
</>
17+
)}
18+
19+
20+
{props.showMultipleTfmSuggestion && (
21+
<>
22+
<p>
23+
<code className="language-cmd">
24+
dotnet publish -f net8.0-desktop -p:Version=1.0.0 -o .\publish
25+
</code>
26+
</p>
27+
<p>
28+
This will create the artifacts to be installed inside of the <code>publish</code> directory. If you are targeting multiple platforms this process will need to be repeated for each of those platforms replacing the <code>-f</code> option with the appropriate target framework moniker (TFM) for each platform, such as <code>net8.0-windows</code> or <code>net8.0-maccatalyst</code>.
29+
</p>
30+
</>
31+
)}
32+
33+
{props.suffix && (
34+
<p>
35+
<span dangerouslySetInnerHTML={{ __html: props.suffix }} />
36+
</p>
37+
)}
38+
39+
<Admonition type="tip">
40+
Starting with .NET 7, the `-o`/`--output` option [can no longer be used with a solution file][def].
41+
42+
Starting with .NET 8 and later, the `dotnet publish` command defaults to the Release configuration, so you can omit the `-c Release` option.
43+
For more details see https://learn.microsoft.com/en-us/dotnet/core/compatibility/sdk/8.0/dotnet-publish-config.
44+
45+
If you execute the dotnet publish command from within the same directory as the .csproj file, you can omit the project argument. You can find more details on the [dotnet publish documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-publish?WT.mc_id=DT-MVP-5003472#arguments).
46+
</Admonition>

‎docs/getting-started/content/_csharp-updates.mdx‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎docs/getting-started/content/_install-cargo.mdx‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎docs/getting-started/content/_install-npm.mdx‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs/getting-started/content/_install-nuget.mdx‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎docs/getting-started/content/_install-pip.mdx‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs/getting-started/content/_install-vpk.mdx‎

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
1-
<FancyStep step={props.step}>
2-
<details>
3-
<summary>
4-
<strong>Install `vpk`</strong>
5-
</summary>
1+
Velopack uses a command line tool called `vpk` to package and publish releases.
2+
It is distributed as a [.NET global tool](https://learn.microsoft.com/dotnet/core/tools/global-tools). Though Velopack can be used with app from [various languages](/#language-support), the .NET is required to install and run `vpk`.
3+
You can install the .NET SDK from the [.NET download page](https://dotnet.microsoft.com/download/dotnet).
64

7-
Velopack uses a command line tool called `vpk` to package and publish releases.
8-
It is distributed as a [.NET global tool](https://learn.microsoft.com/dotnet/core/tools/global-tools). Though Velopack can be used with app from [various languages](/#language-support), the .NET is required to install and run `vpk`.
9-
You can install the .NET SDK from the [.NET download page](https://dotnet.microsoft.com/download/dotnet).
10-
11-
Once .NET is installed, you can install `vpk` by running:
12-
```cmd
13-
dotnet tool install -g vpk
14-
```
15-
</details>
16-
</FancyStep>
5+
Once .NET is installed, you can install `vpk` by running:
6+
```cmd
7+
dotnet tool install -g vpk
8+
```

0 commit comments

Comments
 (0)