Skip to content
This repository was archived by the owner on Sep 10, 2024. It is now read-only.

docs: use file paths io url routes #119

Merged
merged 5 commits into from
Mar 4, 2022
Merged

docs: use file paths io url routes #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1eeb172
docs: use file paths io url routes
stijnmoreels Feb 24, 2022
30ad80a
pr-fix: use '/features' as folder
stijnmoreels Feb 25, 2022
33c72a5
pr-fix: update with lowercase folders
stijnmoreels Feb 25, 2022
d55da89
pr-fix: use correct folder names
stijnmoreels Feb 25, 2022
1157a09
pr-fix: preview link to sub-pages
stijnmoreels Feb 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/preview/01-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ For more granular packages we recommend reading the documentation.
# Features

- **General**
- [Securely Receive CloudEvents](features/general/receive-cloudevents-job)
- [Securely Receive CloudEvents](./02-Features/01-General/receive-cloudevents-job.md)
- **Azure Active Directory**
- [Check Applications in Azure Active Directory for client secrets that have expired or will expire in the near future](features/azureactivedirectory/client-secret-expiration-job)
- [Check Applications in Azure Active Directory for client secrets that have expired or will expire in the near future](./02-Features/04-AzureActiveDirectory/client-secret-expiration-job.md)
- **Azure App Configuration**
- [Automatically refresh configuration values from Azure App Configuration](features/azureappconfiguration/auto-refresh-app-configuration)
- [Automatically refresh configuration values from Azure App Configuration](./02-Features/05-AzureAppConfiguration/auto-refresh-app-configuration.md)
- **Databricks**
- [Measure Databricks job run outcomes as metric](features/databricks/job-metrics)
- [Interact with Databricks to gain insights](features/databricks/gain-insights)
- [Measure Databricks job run outcomes as metric](./02-Features/03-Databricks/job-metrics.md)
- [Interact with Databricks to gain insights](./02-Features/03-Databricks/gain-insights.md)
- **Security**
- [Automatically invalidate cached secrets from Azure Key Vault](features/security/auto-invalidate-secrets)
- [Automatically invalidate cached secrets from Azure Key Vault](./02-Features/02-Security/auto-invalidate-secrets.md)

# License
This is licensed under The MIT License (MIT). Which means that you can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the web application. But you always need to state that Codit is the original author of this web application.
Expand Down
2 changes: 1 addition & 1 deletion docs/preview/02-Features/02-Security/auto-invalidate-secrets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This automation works by subscribing on the `SecretNewVersionCreated` event of a

![Automatically Invalidate Azure Key Vault Secrets](/media/Azure-Key-Vault-Job.png)

To make this automation opperational, following Azure Resources has to be used:
To make this automation operational, following Azure Resources has to be used:
* Azure Key Vault instance
* Azure Service Bus Topic
* Azure Event Grid subscription for `SecretNewVersionCreated` events that are sent to the Azure Service Bus Topic
Expand Down
2 changes: 1 addition & 1 deletion ...tures/02-Security/auto-restart-servicebus-messagepump-on-rotated-credentials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ layout: default
# Automatic Azure Key Vault credentials rotation

The library `Arcus.BackgroundJobs.KeyVault` provides an extension on the message pump to restart the pump automatically when the credentials of the pump stored in Azure Key Vault are changed.
This feature allows more reliable restarting instead of relying on authentication exceptions that may be throwed during the lifetime of the message pump.
This feature allows more reliable restarting instead of relying on authentication exceptions that may be thrown during the lifetime of the message pump.

## How does this work?

Expand Down
4 changes: 2 additions & 2 deletions docs/preview/02-Features/03-Databricks/gain-insights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ PM > Install-Package Arcus.BackgroundJobs.Databricks
## Usage
We provide a `DatabricksInfoProvider` which allows you to interact with Databricks clusters to gain insights on your workloads, such as measuring job run outcomes.

It can be easily setup and used anywhere such as .NET Core workers, Azure Functions and more. We are using this ourselves for our [job metrics](./job-metrics).
It can be easily setup and used anywhere such as .NET Core workers, Azure Functions and more. We are using this ourselves for our [job metrics](./job-metrics.md).

```csharp
using Arcus.BackgroundJobs.Databricks;
Expand All @@ -43,7 +43,7 @@ var endOfWindow = DateTimeOffset.UtcNow;
IEnumerable<JobRun> finishedJobRuns = await provider.GetFinishedJobRunsAsync(startOfWindow, endOfWindow);
```

It provides following information about the job that was executated, such as name & id, along with [details about a single job run](https://github.com/Azure/azure-databricks-client/blob/master/csharp/Microsoft.Azure.Databricks.Client/Run.cs).
It provides following information about the job that was executed, such as name & id, along with [details about a single job run](https://github.com/Azure/azure-databricks-client/blob/master/csharp/Microsoft.Azure.Databricks.Client/Run.cs).

### Measure finished job outcomes
Measures the finished job runs by reporting the results as (multi-dimensional) metrics.
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-v0.1/01-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ For more granular packages we recommend reading the documentation.
# Features

- **General**
- [Securely Receive CloudEvents](features/general/receive-cloudevents-job)
- [Securely Receive CloudEvents](./02-Features/01-General/receive-cloudevents-job.md)
- **Security**
- [Automatically invalidate cached secrets from Azure Key Vault](features/security/auto-invalidate-secrets)
- [Automatically invalidate cached secrets from Azure Key Vault](./02-Features/02-Security/auto-invalidate-secrets.md)

# License
This is licensed under The MIT License (MIT). Which means that you can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the web application. But you always need to state that Codit is the original author of this web application.
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.1/02-Features/01-General/receive-cloudevents-job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can write your own background job(s) by deriving from `CloudEventBackgroundJ

## Usage

You can easily implement your own job by implementing the `ProcessMessageAsync` method to prcocess new CloudEvents.
You can easily implement your own job by implementing the `ProcessMessageAsync` method to process new CloudEvents.

```csharp
using Arcus.BackgroundJobs.CloudEvents;
Expand Down
2 changes: 1 addition & 1 deletion .../versioned_docs/version-v0.1/02-Features/02-Security/auto-invalidate-secrets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This automation works by subscribing on the `SecretNewVersionCreated` event of a

![Automatically Invalidate Azure Key Vault Secrets](/media/Azure-Key-Vault-Job.png)

To make this automation opperational, following Azure Resources has to be used:
To make this automation operational, following Azure Resources has to be used:
* Azure Key Vault instance
* Azure Service Bus Topic
* Azure Event Grid subscription for `SecretNewVersionCreated` events that are sent to the Azure Service Bus Topic
Expand Down
8 changes: 4 additions & 4 deletions docs/versioned_docs/version-v0.2/01-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ For more granular packages we recommend reading the documentation.
# Features

- **General**
- [Securely Receive CloudEvents](features/general/receive-cloudevents-job)
- [Securely Receive CloudEvents](./02-Features/01-General/receive-cloudevents-job.md)
- **Security**
- [Automatically invalidate cached secrets from Azure Key Vault](features/security/auto-invalidate-secrets)
- [Automatically invalidate cached secrets from Azure Key Vault](./02-Features/02-Security/auto-invalidate-secrets.md)
- **Databricks**
- [Measure Databricks job run outcomes as metric](features/databricks/job-metrics)
- [Interact with Databricks to gain insights](features/databricks/gain-insights)
- [Measure Databricks job run outcomes as metric](./02-Features/03-Databricks/job-metrics.md)
- [Interact with Databricks to gain insights](./02-Features/03-Databricks/gain-insights.md)

# License
This is licensed under The MIT License (MIT). Which means that you can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the web application. But you always need to state that Codit is the original author of this web application.
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.2/02-Features/01-General/receive-cloudevents-job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can write your own background job(s) by deriving from `CloudEventBackgroundJ

## Usage

You can easily implement your own job by implementing the `ProcessMessageAsync` method to prcocess new CloudEvents.
You can easily implement your own job by implementing the `ProcessMessageAsync` method to process new CloudEvents.


```csharp
Expand Down
2 changes: 1 addition & 1 deletion .../versioned_docs/version-v0.2/02-Features/02-Security/auto-invalidate-secrets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This automation works by subscribing on the `SecretNewVersionCreated` event of a

![Automatically Invalidate Azure Key Vault Secrets](/media/Azure-Key-Vault-Job.png)

To make this automation opperational, following Azure Resources has to be used:
To make this automation operational, following Azure Resources has to be used:
* Azure Key Vault instance
* Azure Service Bus Topic
* Azure Event Grid subscription for `SecretNewVersionCreated` events that are sent to the Azure Service Bus Topic
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-v0.2/02-Features/03-Databricks/gain-insights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ PM > Install-Package Arcus.BackgroundJobs.Databricks
## Usage
We provide a `DatabricksInfoProvider` which allows you to interact with Databricks clusters to gain insights on your workloads, such as measuring job run outcomes.

It can be easily setup and used anywhere such as .NET Core workers, Azure Functions and more. We are using this ourselves for our [job metrics](./job-metrics).
It can be easily setup and used anywhere such as .NET Core workers, Azure Functions and more. We are using this ourselves for our [job metrics](./job-metrics.md).

```csharp
using Arcus.BackgroundJobs.Databricks;
Expand All @@ -43,7 +43,7 @@ var endOfWindow = DateTimeOffset.UtcNow;
IEnumerable<JobRun> finishedJobRuns = await provider.GetFinishedJobRunsAsync(startOfWindow, endOfWindow);
```

It provides following information about the job that was executated, such as name & id, along with [details about a single job run](https://github.com/Azure/azure-databricks-client/blob/master/csharp/Microsoft.Azure.Databricks.Client/Run.cs).
It provides following information about the job that was executed, such as name & id, along with [details about a single job run](https://github.com/Azure/azure-databricks-client/blob/master/csharp/Microsoft.Azure.Databricks.Client/Run.cs).

### Measure finished job outcomes
Measures the finished job runs by reporting the results as (multi-dimensional) metrics.
Expand Down
8 changes: 4 additions & 4 deletions docs/versioned_docs/version-v0.3/01-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ For more granular packages we recommend reading the documentation.
# Features

- **General**
- [Securely Receive CloudEvents](features/general/receive-cloudevents-job)
- [Securely Receive CloudEvents](./02-Features/01-General/receive-cloudevents-job.md)
- **Security**
- [Automatically invalidate cached secrets from Azure Key Vault](features/security/auto-invalidate-secrets)
- [Automatically invalidate cached secrets from Azure Key Vault](./02-Features/02-Security/auto-invalidate-secrets.md)
- **Databricks**
- [Measure Databricks job run outcomes as metric](features/databricks/job-metrics)
- [Interact with Databricks to gain insights](features/databricks/gain-insights)
- [Measure Databricks job run outcomes as metric](./02-Features/03-Databricks/job-metrics.md)
- [Interact with Databricks to gain insights](./02-Features/03-Databricks/gain-insights.md)

# License
This is licensed under The MIT License (MIT). Which means that you can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the web application. But you always need to state that Codit is the original author of this web application.
Expand Down
2 changes: 1 addition & 1 deletion .../versioned_docs/version-v0.3/02-Features/02-Security/auto-invalidate-secrets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This automation works by subscribing on the `SecretNewVersionCreated` event of a

![Automatically Invalidate Azure Key Vault Secrets](/media/Azure-Key-Vault-Job.png)

To make this automation opperational, following Azure Resources has to be used:
To make this automation operational, following Azure Resources has to be used:
* Azure Key Vault instance
* Azure Service Bus Topic
* Azure Event Grid subscription for `SecretNewVersionCreated` events that are sent to the Azure Service Bus Topic
Expand Down
2 changes: 1 addition & 1 deletion ...tures/02-Security/auto-restart-servicebus-messagepump-on-rotated-credentials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ layout: default
# Automatic Azure Key Vault credentials rotation

The library `Arcus.BackgroundJobs.KeyVault` provides an extension on the message pump to restart the pump automatically when the credentials of the pump stored in Azure Key Vault are changed.
This feature allows more reliable restarting instead of relying on authentication exceptions that may be throwed during the lifetime of the message pump.
This feature allows more reliable restarting instead of relying on authentication exceptions that may be thrown during the lifetime of the message pump.

## How does this work?

Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-v0.3/02-Features/03-Databricks/gain-insights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ PM > Install-Package Arcus.BackgroundJobs.Databricks -Version 0.3.0
## Usage
We provide a `DatabricksInfoProvider` which allows you to interact with Databricks clusters to gain insights on your workloads, such as measuring job run outcomes.

It can be easily setup and used anywhere such as .NET Core workers, Azure Functions and more. We are using this ourselves for our [job metrics](./job-metrics).
It can be easily setup and used anywhere such as .NET Core workers, Azure Functions and more. We are using this ourselves for our [job metrics](./job-metrics.md).

```csharp
using Arcus.BackgroundJobs.Databricks;
Expand All @@ -43,7 +43,7 @@ var endOfWindow = DateTimeOffset.UtcNow;
IEnumerable<JobRun> finishedJobRuns = await provider.GetFinishedJobRunsAsync(startOfWindow, endOfWindow);
```

It provides following information about the job that was executated, such as name & id, along with [details about a single job run](https://github.com/Azure/azure-databricks-client/blob/master/csharp/Microsoft.Azure.Databricks.Client/Run.cs).
It provides following information about the job that was executed, such as name & id, along with [details about a single job run](https://github.com/Azure/azure-databricks-client/blob/master/csharp/Microsoft.Azure.Databricks.Client/Run.cs).

### Measure finished job outcomes
Measures the finished job runs by reporting the results as (multi-dimensional) metrics.
Expand Down