Skip to content

Commit b95b1e3

Browse files
authored
Minor Improvement
1 parent e198fc8 commit b95b1e3

File tree

118 files changed

+456
-456
lines changed

Some content is hidden

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

118 files changed

+456
-456
lines changed

apps/docs/content/dotnet/how-to/access.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Services can be of different types (runtime services, databases, message brokers
1010
To connect to your application with `app` hostname running on [internal port](/dotnet/how-to/build-pipeline#ports) `5000`, simply use `http://app:5000`
1111

1212
:::info
13-
Do not use <code>https://</code> when communicating with .NET from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects.
13+
Do not use `https://` when communicating with .NET from other runtime services in the same project. The internal communication is done over a private network and is isolated from other projects.
1414
:::
1515

1616
### Use .NET environment variables
@@ -41,12 +41,12 @@ You can securely connect to your .NET application from your local workspace via
4141
Once the VPN session is established, you have the secured connection to the project's private network in Zerops. You can access all project services locally by using their hostname. The only difference is that no [environment variables](/dotnet/how-to/env-variables) are available when connected through VPN. To connect to your .NET application in Zerops set the hostname and [internal port](/dotnet/how-to/build-pipeline#ports) e.g. http://app:5000
4242

4343
:::info
44-
Do not use <code>https://</code> when communicating with .NET over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects.
44+
Do not use `https://` when communicating with .NET over the VPN. The security is assured by the VPN. The internal communication is done over a private network and is isolated from other projects.
4545
:::
4646

4747
### Connect via SSH
4848

49-
Use the <a href="/references/ssh"><code>ssh</code> command</a> to connect to your service via SSH.
49+
Use the <a href="/references/ssh">`ssh` command</a> to connect to your service via SSH.
5050

5151
### Stop VPN connection
5252

apps/docs/content/dotnet/how-to/build-pipeline.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ zerops:
117117
<p>
118118
The base build environment contains {data.alpineCurrentVersion}, the selected
119119
major version of .NET, <a href="/references/cli">Zerops command line tool</a>,{' '}
120-
<code>ASP .NET</code> and <code>git</code>.
120+
`ASP .NET` and `git`.
121121
</p>
122122

123123
:::info
@@ -290,7 +290,7 @@ If the command ends successfully, it returns the exit code 0 and Zerops triggers
290290

291291
### deployFiles
292292

293-
_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use <a href="#deployignore"><code>.deployignore</code></a> file.
293+
_REQUIRED._ Selects which files or folders will be deployed after the build has successfully finished. To filter out specific files or folders, use <a href="#deployignore">`.deployignore`</a> file.
294294

295295
```yml
296296
# REQUIRED. Select which files / folders to deploy after
@@ -351,7 +351,7 @@ deployFiles: ./path/~/to/
351351

352352
#### .deployignore
353353

354-
Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a <a href="https://git-scm.com/docs/gitignore#_pattern_format"><code>.gitignore</code></a> file.
354+
Add a `.deployignore` file to the root of your project and specify which files and folders Zerops should ignore during deploy. The syntax is the same as of a <a href="https://git-scm.com/docs/gitignore#_pattern_format">`.gitignore`</a> file.
355355

356356
Example to ignore `src/file.txt` file in deploy:
357357

@@ -367,7 +367,7 @@ src / file.txt;
367367
```
368368

369369
:::note
370-
`.deployignore` file also works with <a href="/references/cli/commands#deploy"><code>zcli service deploy</code></a> command.
370+
`.deployignore` file also works with <a href="/references/cli/commands#deploy">`zcli service deploy`</a> command.
371371
:::
372372

373373
### cache
@@ -518,7 +518,7 @@ _OPTIONAL._ Customises the .NET runtime environment by installing additional dep
518518
<p>
519519
The base .NET environment contains {data.alpineCurrentVersion}, the selected
520520
major version of .NET, <a href="/references/cli">Zerops command line tool</a>{' '}
521-
and <code>ASP .NET</code> and <code>git</code>. To install additional packages
521+
and `ASP .NET` and `git`. To install additional packages
522522
or tools add one or more prepare commands:
523523
</p>
524524

@@ -573,7 +573,7 @@ You can configure your prepare commands to be run in a single shell instance or
573573
The prepare runtime container contains {data.alpineCurrentVersion}, the
574574
selected major version of .NET,{' '}
575575
<a href="/references/cli">Zerops command line tool</a> and{' '}
576-
<code>ASP .NET</code> and <code>git</code>.
576+
`ASP .NET` and `git`.
577577
</p>
578578

579579
The prepare runtime container does not contain your application code nor the built application. If you need to copy some folders or files from the build container to the runtime container (e.g. a configuration file) use the `addToRunPrepare` attribute in the [build section](#build-pipeline-configuration).

apps/docs/content/dotnet/how-to/build-process.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The default .NET build environment contains:
4444
- [zCLI](/references/cli), Zerops command line tool
4545
- ASP .NET`and`git`
4646

47-
If you prefer the Ubuntu OS instead of Alpine, set the <code><a href="/dotnet/how-to/build-pipeline#os">build.os</a></code> attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/dotnet/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`.
47+
If you prefer the Ubuntu OS instead of Alpine, set the `<a href="/dotnet/how-to/build-pipeline#os">build.os</a>` attribute to `ubuntu`. To install additional packages or tools add one or more [build.prepareCommands](/dotnet/how-to/build-pipeline#preparecommands) commands to your `zerops.yml`.
4848

4949
:::info
5050
The application code is available in the `/var/www` folder in your build container before the prepare commands are triggered. This allows you to use any file from your application code in your prepare commands (e.g. a configuration file).

apps/docs/content/dotnet/how-to/create.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ At least one service in `services:` section is required. You can create a projec
268268
<br />
269269
<br />
270270
The hostname of the new database will be set to the{' '}
271-
<code>hostname</code> value. <br />
271+
`hostname` value. <br />
272272
<br />
273273
<b>Limitations:</b>
274274
<br />- duplicate services with the same name in the same project are
@@ -283,16 +283,16 @@ At least one service in `services:` section is required. You can create a projec
283283
<b>type</b>
284284
</td>
285285
<td>
286-
Specifies the service type <code>dotnet</code> and version.
286+
Specifies the service type `dotnet` and version.
287287
<br />
288288
Set type:{' '}
289-
<code>
289+
`
290290
dotnet<span>@</span>&lt;version&gt;
291-
</code>{' '}
291+
`{' '}
292292
or{' '}
293-
<code>
293+
`
294294
dotnet<span>@</span>latest
295-
</code>
295+
`
296296
<br />
297297
<br />
298298
<b>Limitations:</b>
@@ -319,8 +319,8 @@ At least one service in `services:` section is required. You can create a projec
319319
<b> - cpuMode</b>
320320
</td>
321321
<td>
322-
<b>Optional.</b> Accepts <code>SHARED</code>, <code>DEDICATED</code>{' '}
323-
values. Default is <code>SHARED</code>
322+
<b>Optional.</b> Accepts `SHARED`, `DEDICATED`{' '}
323+
values. Default is `SHARED`
324324
</td>
325325
</tr>
326326
<tr>

apps/docs/content/dotnet/how-to/customize-runtime.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ The default .NET runtime environment contains:
1818
- <span>{data.alpineCurrentVersion}</span>
1919
- selected version of .NET selected when the runtime service was created.
2020
- <a href="/references/cli">
21-
<code>zCLI</code>
21+
`zCLI`
2222
</a>
2323
, Zerops command line tool
2424
- ASP .NET`and`git`
2525

26-
If you prefer the Ubuntu OS instead of Alpine, set the <code><a href="/dotnet/how-to/build-pipeline#os">build.os</a></code> attribute to `ubuntu`. To install additional packages or tools add one or more <a href="/dotnet/how-to/build-pipeline#preparecommands-1"><code>run.prepareCommands</code></a> commands to your `zerops.yml`.
26+
If you prefer the Ubuntu OS instead of Alpine, set the `<a href="/dotnet/how-to/build-pipeline#os">build.os</a>` attribute to `ubuntu`. To install additional packages or tools add one or more <a href="/dotnet/how-to/build-pipeline#preparecommands-1">`run.prepareCommands`</a> commands to your `zerops.yml`.
2727

2828
When the first deploy with a defined `prepareCommands` attribute is triggered, Zerops will
2929

@@ -41,7 +41,7 @@ The prepare runtime container is automatically deleted after the prepare runtime
4141

4242
Some packages or tools can take a long time to install. Therefore, Zerops caches your custom runtime environment after the installation of your custom packages or tools is completed. When the second or following deploy is triggered, Zerops will use the custom runtime cache from the previous deploy if following conditions are met:
4343

44-
1. Content of the <a href="/dotnet/how-to/build-pipeline#copy-folders-or-files-from-your-build-container"><code>build.addToRunPrepare</code></a> and <a href="/dotnet/how-to/build-pipeline#preparecommands-1"><code>run.prepareCommands</code></a> attributes didn't change from the previous deploy
44+
1. Content of the <a href="/dotnet/how-to/build-pipeline#copy-folders-or-files-from-your-build-container">`build.addToRunPrepare`</a> and <a href="/dotnet/how-to/build-pipeline#preparecommands-1">`run.prepareCommands`</a> attributes didn't change from the previous deploy
4545
2. The custom runtime cache wasn't invalidated in the Zerops GUI.
4646

4747
To invalidate the custom runtime cache go to `yyy`

apps/docs/content/dotnet/how-to/deploy-process.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ Zerops performs following actions for each new container:
3939
Services with multiple containers are deployed in parallel.
4040

4141
:::info
42-
If your application needs to be initialized in each runtime container, add [init commands](/dotnet/how-to/build-pipeline#initcommands) to <code>zerops.yml</code>.
42+
If your application needs to be initialized in each runtime container, add [init commands](/dotnet/how-to/build-pipeline#initcommands) to `zerops.yml`.
4343
:::
4444

4545
:::caution
46-
Do not use the <code>initCommands</code> for customising your runtime environment. See [how to customise the runtime environment](/dotnet/how-to/deploy-process#customise-dotnet-runtime-environment).
46+
Do not use the `initCommands` for customising your runtime environment. See [how to customise the runtime environment](/dotnet/how-to/deploy-process#customise-dotnet-runtime-environment).
4747
:::
4848

4949
## Further deploys
@@ -70,9 +70,9 @@ Application in the runtime container with a pending readiness check won't receiv
7070

7171
If the readiness check is still failing after 5 minutes, the specific runtime container is marked as failed and Zerops will delete it, create a new runtime container and perform the deploy.
7272

73-
The <a href="/dotnet/how-to/build-pipeline#httpget"><code>httpGet</code></a> readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect.
73+
The <a href="/dotnet/how-to/build-pipeline#httpget">`httpGet`</a> readiness check is successful when the URL returns HTTP status code `2xx`. The timeout is 5 seconds. When the URL returns a `3xx` HTTP status, the readiness check HTTP client will follow the redirect.
7474

75-
The <a href="/dotnet/how-to/build-pipeline#exec"><code>exec.command</code></a> readiness check is successful when the command returns status code 0. The timeout is 5 seconds.
75+
The <a href="/dotnet/how-to/build-pipeline#exec">`exec.command`</a> readiness check is successful when the command returns status code 0. The timeout is 5 seconds.
7676

7777
Read the [runtime log](/dotnet/how-to/logs#runtime-log) to troubleshoot failed readiness checks.
7878

apps/docs/content/dotnet/how-to/logs.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,11 @@ app.Logger.LogInformation('<7>Debug (7) severity > debug-level message.');
8888

8989
:::info
9090

91-
<code>logger.LogTrace</code>, <code>logger.LogInformation</code>,
92-
<code>logger.LogWarning</code>, <code>logger.LogDebug</code>, <code>
91+
`logger.LogTrace`, `logger.LogInformation`,
92+
`logger.LogWarning`, `logger.LogDebug`, `
9393
logger.LogError
94-
</code> and <code>logger.LogCritical</code> are just aliases to the <code>
94+
` and `logger.LogCritical` are just aliases to the `
9595
logger.LogInformation
96-
</code> method. They don't set the appropriate severity number. Use the <code>
96+
` method. They don't set the appropriate severity number. Use the `
9797
&lt;N&gt;
98-
</code> prefix instead. :::
98+
` prefix instead. :::

apps/docs/content/dotnet/how-to/trigger-pipeline.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Then each time you create a new tag or push to a specific branch, depending on t
3434
</p>
3535

3636
:::info
37-
You can change the build and deploy pipeline when you need to. Just simply modify the <code>zerops.yml</code> in your repository.
37+
You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository.
3838
:::
3939

4040
### Skip the automatic pipeline once
@@ -60,7 +60,7 @@ To start a new build & deploy pipeline manually, use the Zerops CLI.
6060

6161
Follow these steps:
6262

63-
1. Add <a href="/dotnet/how-to/build-pipeline#add-zeropsyml-to-your-repository"><code>zerops.yml</code></a> to your repository.
63+
1. Add <a href="/dotnet/how-to/build-pipeline#add-zeropsyml-to-your-repository">`zerops.yml`</a> to your repository.
6464
2. [Install & setup zCLI](/references/cli) the Zerops command line tool.
6565
3. Run `zcli push` command.
6666

@@ -96,7 +96,7 @@ Flags:
9696
zCLI commands are interactive, when you press enter after `zcli push`, you will be given a list of your projects to choose from.
9797
9898
:::info
99-
You can change the build and deploy pipeline when you need to. Just simply modify the <code>zerops.yml</code> in your repository.
99+
You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository.
100100
:::
101101
102102
## Manual deploy using Zerops CLI
@@ -138,5 +138,5 @@ Flags:
138138
`zerops.yml` must be placed in the working directory.
139139
140140
:::info
141-
You can change the deploy pipeline when you need to. Just simply modify the <code>zerops.yml</code> in your working directory.
141+
You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory.
142142
:::

apps/docs/content/dotnet/how-to/upgrade.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
title: How to upgrade the .NET version
33
---
44

5-
You can upgrade or downgrade your .NET service to a different major .NET version by setting the <a href="/dotnet/how-to/build-pipeline#base-1"><code>run.base</code></a> parameter in your `zerops.yml`. When you [trigger a new pipeline](/dotnet/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required .NET version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current .NET version for your runtime.
5+
You can upgrade or downgrade your .NET service to a different major .NET version by setting the <a href="/dotnet/how-to/build-pipeline#base-1">`run.base`</a> parameter in your `zerops.yml`. When you [trigger a new pipeline](/dotnet/how-to/trigger-pipeline), Zerops will start new runtime container(s) with the required .NET version. If you don't specify the `run.base` attribute in your `zerops.yml`, Zerops keeps the current .NET version for your runtime.
66

7-
If you want to build your application with a different major .NET version, change the <a href="/dotnet/how-to/build-pipeline#base"><code>build.base</code></a> parameter in your `zerops.yml`. The `build.base` is the required attribute.
7+
If you want to build your application with a different major .NET version, change the <a href="/dotnet/how-to/build-pipeline#base">`build.base`</a> parameter in your `zerops.yml`. The `build.base` is the required attribute.

apps/docs/content/dotnet/tutorial/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ services:
2929
**That's it, your application is now up and running! :star: Let's check it works:**
3030
3131
1. A _subdomain_ should have been enabled and visible in the project's **IP addressed & Public Routing Overview** box. Its format should look similar to this `https://helloworld-24-8080.prg1.zerops.app`.
32-
2. Click or the <code>subdomain</code> URL to open it in a browser and you should see
32+
2. Click or the `subdomain` URL to open it in a browser and you should see
3333

3434
```
3535
Hello, World!

0 commit comments

Comments
 (0)