Skip to content

Commit 36bccf4

Browse files
committed
Clean up links and redirects
1 parent f8f3a7a commit 36bccf4

File tree

7 files changed

+12
-105
lines changed

7 files changed

+12
-105
lines changed

docs/getting-started/fusion-cli.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ These are the possible outputs:
2525
- **Unrecoverable error:** empty stdout and `exitCode != 0`. A [log file](#logging) will be created.
2626
- **Update is availble:** stdout contains json object and `exitCode == 0`.
2727

28-
When an update is available, you'll receive an [UpdateInfo](../reference/cs/Velopack/UpdateInfo.md) object via stdout:
28+
When an update is available, you'll receive an [UpdateInfo](../reference/cs/Velopack/UpdateInfo) object via stdout:
2929

3030
```json
3131
{

docs/integrating/hooks.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Hooks allow your application to run logic at various stages of the install/update/uninstall process.
55

6-
In general, I don't recommend trying to handle hooks manually - and instead refer to the available [VelopackApp](../reference/cs/Velopack/VelopackApp.md) options.
6+
In general, I don't recommend trying to handle hooks manually - and instead refer to the available [VelopackApp](../reference/cs/Velopack/VelopackApp) options.
77

88
If you wish to handle these yourself, an SDK doesn't exist for your language, or you just want to learn more about it, read on.
99

docs/integrating/overview.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ static void Main(string[] args)
4040
}
4141
```
4242

43-
The full list of options [for VelopackApp is available here](../reference/cs//Velopack/VelopackApp.md). You can also read more about [how hooks work](./hooks.mdx).
43+
The full list of options [for VelopackApp is available here](../reference/cs/Velopack/VelopackApp). You can also read more about [how hooks work](./hooks.mdx).
4444

4545
:::warning
4646
A "FastCallback" requires that your application show no UI and exit quickly. When the callback returns, your application will exit. If you do not exit this callback quickly enough your process will be killed.
4747
:::
4848

4949
## Configuring Updates
50-
Updates can be accomplished by adding [UpdateManager](../reference/cs/Velopack/UpdateManager.md) to your app:
50+
Updates can be accomplished by adding [UpdateManager](../reference/cs/Velopack/UpdateManager) to your app:
5151

5252
```cs
5353
private static async Task UpdateMyApp()
@@ -76,12 +76,12 @@ You can host your update packages basically anywhere, here are a few examples:
7676
- HTTP server, or S3, Azure Storage, etc:<br/>`new UpdateManager("https://the.place/you-host/updates")`
7777
- GitHub Releases:<br/>`new UpdateManager(new GitHubSource("https://github.com/yourName/yourRepo")`
7878

79-
There are a variety of built-in sources (eg. [GithubSource](../reference/cs/Velopack.Sources/GithubSource.md), [SimpleWebSource](../reference/cs/Velopack.Sources/SimpleWebSource.md)) you can use when checking for updates, but you can also build your own by [deriving from IUpdateSource](../reference/cs/Velopack.Sources/IUpdateSource.md).
79+
There are a variety of built-in sources (eg. [GithubSource](../reference/cs/Velopack/Sources/GithubSource), [SimpleWebSource](../reference/cs/Velopack/Sources/SimpleWebSource)) you can use when checking for updates, but you can also build your own by [deriving from IUpdateSource](../reference/cs/Velopack/Sources/IUpdateSource).
8080

8181
### Check for updates
82-
`CheckForUpdatesAsync` will read the provided update source for a `releases.{channel}.json` file to retrieve available updates ([Read about channels](../packaging/channels.mdx)). If there is an update available, a non-null [UpdateInfo](../reference/cs/Velopack/UpdateInfo.md) will be returned with some details about the update. You can also [retrieve any release notes](release-notes.mdx) which were provided when the update was packaged.
82+
`CheckForUpdatesAsync` will read the provided update source for a `releases.{channel}.json` file to retrieve available updates ([Read about channels](../packaging/channels.mdx)). If there is an update available, a non-null [UpdateInfo](../reference/cs/Velopack/UpdateInfo) will be returned with some details about the update. You can also [retrieve any release notes](release-notes.mdx) which were provided when the update was packaged.
8383

84-
There are [also some options](../reference/cs/Velopack/UpdateOptions.md) which can be passed in to [UpdateManager](../reference/cs/Velopack/UpdateManager.md) to customise how updates are handled, eg. to allow things like [switching channels](switching-channels.mdx).
84+
There are [also some options](../reference/cs/Velopack/UpdateOptions) which can be passed in to [UpdateManager](../reference/cs/Velopack/UpdateManager) to customise how updates are handled, eg. to allow things like [switching channels](switching-channels.mdx).
8585

8686
### Download updates
8787
`DownloadUpdatesAsync` will attempt to download deltas (if available) and re-construct the latest full release. If there are no deltas available, or the delta reconstruction fails, the latest full release package will be downloaded instead. Note that if an option like `AllowVersionDowngrade` is specified, the downloaded version might be older than the currently executing version.

docs/troubleshooting/cli.mdx

-96
This file was deleted.

docs/troubleshooting/debugging.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ new UpdateManager("https://path.to/your-updates", logger: new ConsoleLogger());
2929
## Logging in the Velopack binaries
3030

3131
### Windows
32-
Running Update.exe will log most output to it's base directory as `Velopack.log`. Setup.exe will not log to file by default. However, you can override the log location for both binaries with the `--log {path}` parameter. You can also use the `--verbose` flag to capture debug/trace output to log. Unfortunately, on Windows, to avoid showing up as a console window, these binaries are compiled as a WinExe and there will be no console output by default. Please see the [command line reference](cli.mdx) for a comprehensive list of arguments supported.
32+
Running Update.exe will log most output to it's base directory as `Velopack.log`. Setup.exe will not log to file by default. However, you can override the log location for both binaries with the `--log {path}` parameter. You can also use the `--verbose` flag to capture debug/trace output to log. Unfortunately, on Windows, to avoid showing up as a console window, these binaries are compiled as a WinExe and there will be no console output by default.
33+
Please see the [command line reference](../reference/cli) for a comprehensive list of arguments supported.
3334

3435
### Linux
3536
All logs will be sent to `/tmp/velopack.log`.

docusaurus.config.ts

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ const config: Config = {
2929
['@docusaurus/plugin-client-redirects', {
3030
redirects: [
3131
{ from: '/packaging/rid', to: '/packaging/runtime' },
32+
{ from: '/troubleshooting/cli', to: '/reference/cli' },
3233
],
3334
}],
3435
],

sidebars.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,10 @@ const sidebars: SidebarsConfig = {
7171
auto("distributing", "Distributing", "Learn how to distribute your Velopack releases to your users."),
7272

7373
title("Advanced"),
74-
auto("troubleshooting", "Troubleshooting", "Debugging steps, common issues and how to resolve them."),
7574
auto("contributing", "Contributing", "Learn how to contribute to the Velopack project."),
7675
auto("migrating", "Migrating", "Learn how to migrate your existing application to Velopack."),
76+
doc("troubleshooting/debugging", "Debugging & Logging"),
77+
doc("troubleshooting/faq", "FAQ"),
7778
],
7879
referenceSidebar: [
7980
{

0 commit comments

Comments
 (0)