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

Commit 0ea95e6

Browse files
docs: Prefix version numbers with "v" (#75)
* ✨ add Docusaurus (#1) * 🔨 remove broken links + update config * 🎨 update sidebar config + github repo * 🔨 update footer * 💄 theming * 🎨 add logo * 🎨 update logos * 💄 Footer styling updates * 🍱 Add favicon * ✨ use dev config file * 💚 env variables (#2) * Auto stash before merge of "master" and "origin/master" * 📝 Add documentation * 👌 change logo * 💄 update dark theme colors * ✨ seo image * 🔥 remove docs from root * 🔥 restore src files * 🔥 undo .github files removal * ✨ update preview docs + github references * 🔨 fix broken link * 💄 alert background fix * 👌 rename docs to documentation * 👌 add support for csharp * 👌 update organisation name * 👌 update URL * 👌 rename docs to next * 👌 update README * 👌 rename unreleased docs folder to preview * 🔥 remove unused images * 👌 add netlify.toml * Change Netlify name * ✨ Update index page title + prefix versions with v * 🔥 remove old versions * 👌 change favicon * 👌 Setup v0.1 + edit url fix * 👌 Fix wrong link v0.1 Co-authored-by: Tom Kerkhove <[email protected]>
1 parent 82fb0fc commit 0ea95e6

File tree

15 files changed

+16
-11
lines changed

15 files changed

+16
-11
lines changed

docs/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ https://docusaurus.io/docs/configuration
4949

5050
When creating a new documentation website update these values within the `docusaurus.config.js` file:
5151

52-
5352
```typescript
5453
{
5554
title,

docs/docusaurus.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module.exports = {
88
baseUrl: '/',
99
onBrokenLinks: 'throw',
1010
onBrokenMarkdownLinks: 'warn',
11-
favicon: 'img/favicon.png',
11+
favicon: 'img/arcus.png',
1212
organizationName: 'arcus-azure', // Usually your GitHub org/user name.
1313
projectName: 'Arcus Background Jobs', // Usually your repo name.
1414
themeConfig: {
@@ -75,7 +75,7 @@ module.exports = {
7575
path: 'preview',
7676
// Please change this to your repo.
7777
editUrl:
78-
'https://github.com/arcus-azure/arcus.backgroundjobs/edit/master',
78+
'https://github.com/arcus-azure/arcus.backgroundjobs/edit/master/docs',
7979
includeCurrentVersion:process.env.CONTEXT !== 'production',
8080
},
8181
theme: {

docs/preview/01-index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
2-
id: home
3-
title: "Home"
4-
slug: "/"
2+
title: "Arcus Background Jobs"
3+
layout: default
4+
permalink: /
5+
slug: /
6+
sidebar_label: Welcome
57
---
68

79
[![NuGet Badge](https://buildstats.info/nuget/Arcus.BackgroundJobs.CloudEvents?includePreReleases=true)](https://www.nuget.org/packages/Arcus.BackgroundJobs.CloudEvents/)

docs/static/img/favicon.png

-762 Bytes
Binary file not shown.

docs/versioned_docs/version-0.1/index.md renamed to docs/versioned_docs/version-v0.1/01-index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
2-
title: "Home"
2+
title: "Arcus Background Jobs"
33
layout: default
4+
permalink: /
5+
slug: /
6+
sidebar_label: Welcome
47
---
58

69
[![NuGet Badge](https://buildstats.info/nuget/Arcus.BackgroundJobs.CloudEvents?packageVersion=0.1.0)](https://www.nuget.org/packages/Arcus.BackgroundJobs.CloudEvents/0.1.0)
@@ -18,7 +21,7 @@ For more granular packages we recommend reading the documentation.
1821
# Features
1922

2023
- **General**
21-
- [Securely Receive CloudEvents](features/cloudevent/receive-cloudevents-job)
24+
- [Securely Receive CloudEvents](features/general/receive-cloudevents-job)
2225
- **Security**
2326
- [Automatically invalidate cached secrets from Azure Key Vault](features/security/auto-invalidate-secrets)
2427

File renamed without changes.
File renamed without changes.

docs/versioned_docs/version-0.2/01-index.md renamed to docs/versioned_docs/version-v0.2/01-index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: "Home"
2+
title: "Arcus Background Jobs"
33
layout: default
44
permalink: /
55
slug: /
6+
sidebar_label: Welcome
67
---
78

89
[![NuGet Badge](https://buildstats.info/nuget/Arcus.BackgroundJobs.CloudEvents?includePreReleases=true)](https://www.nuget.org/packages/Arcus.BackgroundJobs.CloudEvents/)
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)