Skip to content

Commit

Permalink
use ` instead of <code>
Browse files Browse the repository at this point in the history
  • Loading branch information
nermalcat69 committed Sep 30, 2024
1 parent 79abd34 commit 6461f9e
Show file tree
Hide file tree
Showing 113 changed files with 434 additions and 434 deletions.
6 changes: 3 additions & 3 deletions apps/docs/content/dotnet/how-to/access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Services can be of different types (runtime services, databases, message brokers
To connect to your application with `app` hostname running on [internal port](/dotnet/how-to/build-pipeline#ports) `5000`, simply use `http://app:5000`

:::info
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.
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.
:::

### Use .NET environment variables
Expand Down Expand Up @@ -41,12 +41,12 @@ You can securely connect to your .NET application from your local workspace via
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

:::info
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.
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.
:::

### Connect via SSH

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

### Stop VPN connection

Expand Down
12 changes: 6 additions & 6 deletions apps/docs/content/dotnet/how-to/build-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ zerops:
<p>
The base build environment contains {data.alpineCurrentVersion}, the selected
major version of .NET, <a href="/references/cli">Zerops command line tool</a>,{' '}
<code>ASP .NET</code> and <code>git</code>.
`ASP .NET` and `git`.
</p>

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

### deployFiles

_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.
_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.

```yml
# REQUIRED. Select which files / folders to deploy after
Expand Down Expand Up @@ -351,7 +351,7 @@ deployFiles: ./path/~/to/

#### .deployignore

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.
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.

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

Expand All @@ -367,7 +367,7 @@ src / file.txt;
```

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

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

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

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).
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/dotnet/how-to/build-process.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The default .NET build environment contains:
- [zCLI](/references/cli), Zerops command line tool
- ASP .NET`and`git`

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`.
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`.

:::info
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).
Expand Down
16 changes: 8 additions & 8 deletions apps/docs/content/dotnet/how-to/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ At least one service in `services:` section is required. You can create a projec
<br />
<br />
The hostname of the new database will be set to the{' '}
<code>hostname</code> value. <br />
`hostname` value. <br />
<br />
<b>Limitations:</b>
<br />- duplicate services with the same name in the same project are
Expand All @@ -283,16 +283,16 @@ At least one service in `services:` section is required. You can create a projec
<b>type</b>
</td>
<td>
Specifies the service type <code>dotnet</code> and version.
Specifies the service type `dotnet` and version.
<br />
Set type:{' '}
<code>
`
dotnet<span>@</span>&lt;version&gt;
</code>{' '}
`{' '}
or{' '}
<code>
`
dotnet<span>@</span>latest
</code>
`
<br />
<br />
<b>Limitations:</b>
Expand All @@ -319,8 +319,8 @@ At least one service in `services:` section is required. You can create a projec
<b> - cpuMode</b>
</td>
<td>
<b>Optional.</b> Accepts <code>SHARED</code>, <code>DEDICATED</code>{' '}
values. Default is <code>SHARED</code>
<b>Optional.</b> Accepts `SHARED`, `DEDICATED`{' '}
values. Default is `SHARED`
</td>
</tr>
<tr>
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/content/dotnet/how-to/customize-runtime.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ The default .NET runtime environment contains:
- <span>{data.alpineCurrentVersion}</span>
- selected version of .NET selected when the runtime service was created.
- <a href="/references/cli">
<code>zCLI</code>
`zCLI`
</a>
, Zerops command line tool
- ASP .NET`and`git`

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`.
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`.

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

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

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:

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
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
2. The custom runtime cache wasn't invalidated in the Zerops GUI.

To invalidate the custom runtime cache go to `yyy`
Expand Down
8 changes: 4 additions & 4 deletions apps/docs/content/dotnet/how-to/deploy-process.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ Zerops performs following actions for each new container:
Services with multiple containers are deployed in parallel.

:::info
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>.
If your application needs to be initialized in each runtime container, add [init commands](/dotnet/how-to/build-pipeline#initcommands) to `zerops.yml`.
:::

:::caution
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).
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).
:::

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

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.

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.
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.

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.
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.

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

Expand Down
10 changes: 5 additions & 5 deletions apps/docs/content/dotnet/how-to/logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,11 @@ app.Logger.LogInformation('<7>Debug (7) severity > debug-level message.');

:::info

<code>logger.LogTrace</code>, <code>logger.LogInformation</code>,
<code>logger.LogWarning</code>, <code>logger.LogDebug</code>, <code>
`logger.LogTrace`, `logger.LogInformation`,
`logger.LogWarning`, `logger.LogDebug`, `
logger.LogError
</code> and <code>logger.LogCritical</code> are just aliases to the <code>
` and `logger.LogCritical` are just aliases to the `
logger.LogInformation
</code> method. They don't set the appropriate severity number. Use the <code>
` method. They don't set the appropriate severity number. Use the `
&lt;N&gt;
</code> prefix instead. :::
` prefix instead. :::
8 changes: 4 additions & 4 deletions apps/docs/content/dotnet/how-to/trigger-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Then each time you create a new tag or push to a specific branch, depending on t
</p>

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

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

Follow these steps:

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

Expand Down Expand Up @@ -96,7 +96,7 @@ Flags:
zCLI commands are interactive, when you press enter after `zcli push`, you will be given a list of your projects to choose from.
:::info
You can change the build and deploy pipeline when you need to. Just simply modify the <code>zerops.yml</code> in your repository.
You can change the build and deploy pipeline when you need to. Just simply modify the `zerops.yml` in your repository.
:::
## Manual deploy using Zerops CLI
Expand Down Expand Up @@ -138,5 +138,5 @@ Flags:
`zerops.yml` must be placed in the working directory.
:::info
You can change the deploy pipeline when you need to. Just simply modify the <code>zerops.yml</code> in your working directory.
You can change the deploy pipeline when you need to. Just simply modify the `zerops.yml` in your working directory.
:::
4 changes: 2 additions & 2 deletions apps/docs/content/dotnet/how-to/upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
title: How to upgrade the .NET version
---

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.
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.

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.
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.
2 changes: 1 addition & 1 deletion apps/docs/content/dotnet/tutorial/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ services:
**That's it, your application is now up and running! :star: Let's check it works:**
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`.
2. Click or the <code>subdomain</code> URL to open it in a browser and you should see
2. Click or the `subdomain` URL to open it in a browser and you should see

```
Hello, World!
Expand Down
10 changes: 5 additions & 5 deletions apps/docs/content/dotnet/tutorial/runtime-sql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ In the detail of each step, you can find a link with more information about the
<details>
<summary>
3. In the left menu, click on <b>Import services</b>, copy & paste the
contents of the <code>import-services.yml</code> config file from the recipe
contents of the `import-services.yml` config file from the recipe
repository of your choice. Then click on <b>Import service</b>.
</summary>
<p>
Expand All @@ -45,7 +45,7 @@ In the detail of each step, you can find a link with more information about the
to an existing project.
</p>
<p>
The yaml file includes a <code>buildFromGit</code> directive, which ensures
The yaml file includes a `buildFromGit` directive, which ensures
a one-time build from Git repository source. See how to connect a{' '}
<a href="/references/github-integration">Github</a> or{' '}
<a href="/references/github-integration">Gitlab</a> repository to be able to
Expand Down Expand Up @@ -75,7 +75,7 @@ Learn more about how to access <a href="/dotnet/how-to/logs#build-log">build log
</details>

<details>
<summary>6. Once the pipeline has finished, click on the activated <i>subdomain</i> URL. You should see a simple page with <br/><br/><code>Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1</code></summary>
<summary>6. Once the pipeline has finished, click on the activated <i>subdomain</i> URL. You should see a simple page with <br/><br/>`Entry added successfully with random data: f47ac10b-58cc-0372-8567-0e02b2c3d479. Total count: 1`</summary>
<p>
Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon.

Expand All @@ -86,14 +86,14 @@ For now, check out other features, such as <a href="/dotnet/how-to/env-variables

<details>
<summary>
7. One of the services is <code>adminer</code>, a database management tool.
7. One of the services is `adminer`, a database management tool.
See how to{' '}
<a href="/postgresql/how-to/manage#how-to-access-adminer">access it</a>.
</summary>
<p>
Learn more about how to{' '}
<a href="/postgresql/how-to/manage#how-to-use-psql-cli-on-your-workstation">
use <code>psql</code>
use `psql`
</a>{' '}
command-line tool instead or how to{' '}
<a href="/postgresql/how-to/export-import-data">import and export data</a>{' '}
Expand Down
4 changes: 2 additions & 2 deletions apps/docs/content/dotnet/tutorial/step-by-step.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ In the detail of each step, you can find a link with more information about the
to an existing project.
</p>
<p>
The yaml file includes a <code>buildFromGit</code> directive, which ensures
The yaml file includes a `buildFromGit` directive, which ensures
a one-time build from Git repository source. See how to connect a{' '}
<a href="/references/github-integration">Github</a> or{' '}
<a href="/references/github-integration">Gitlab</a> repository to be able to
Expand Down Expand Up @@ -78,7 +78,7 @@ Learn more about how to access <a href="/dotnet/how-to/logs#build-log">build log
</details>

<details>
<summary>6. Once the pipeline has finished, click on the activated <i>subdomain</i> URL:<br/><br/> You should see a simple page with <code>Hello World!</code> printed.</summary>
<summary>6. Once the pipeline has finished, click on the activated <i>subdomain</i> URL:<br/><br/> You should see a simple page with `Hello World!` printed.</summary>
<p>
Congratulations! You have created your first application in Zerops, and we hope to see your own projects soon.

Expand Down
Loading

0 comments on commit 6461f9e

Please sign in to comment.