Upgrade to Docusaurus v3 (#110)

https://docusaurus.io/blog/releases/3.0
This commit is contained in:
Caleb Jasik 2023-11-01 11:45:02 -05:00 committed by GitHub
parent d8a5db0dbe
commit 50721a82dd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 1803 additions and 1111 deletions

View file

@ -4,8 +4,6 @@ on:
branches:
- main
pull_request:
branches:
- main
# Cancel in-progress workflows on the same branch
concurrency:

View file

@ -126,7 +126,7 @@ a large nebula network.
## lighthouse.hosts
:::caution
:::warning
This should be empty on lighthouse nodes

View file

@ -5,7 +5,7 @@ description: local_ranges has been deprecated in favor of preferred_ranges
# local_range
:::caution
:::warning
`local_range` has been deprecated in favor of [`preferred_ranges`](/docs/config/preferred-ranges/)

View file

@ -35,7 +35,7 @@ Disables timestamp logging. Useful when output is redirected to logging system t
## logging.timestamp_format
`timestamp_format` is specified in Go time format, see: <https://golang.org/pkg/time/#pkg-constants>.
`timestamp_format` is specified in Go time format, see: https://golang.org/pkg/time/#pkg-constants.
The default when `format: json` is set is an [RFC3339 timestamp](https://datatracker.ietf.org/doc/html/rfc3339), e.g.
`"2006-01-02T15:04:05Z07:00"`.

View file

@ -25,7 +25,7 @@ static_map:
Select the IP version used to communicate with hosts in the static map. Valid values are `ip4`, `ip6`, and `ip` (for
both.)
:::caution
:::warning
In general, this should be left as the default value `ip4` to avoid issues communicating with IPv4-only hosts.

View file

@ -69,7 +69,7 @@ Config options if `stats.type` is chosen to be `graphite`
</Pill>
The prefix for Graphite metrics that nebula will prepend:
<https://graphite.readthedocs.io/en/latest/feeding-carbon.html#step-1-plan-a-naming-hierarchy>
https://graphite.readthedocs.io/en/latest/feeding-carbon.html#step-1-plan-a-naming-hierarchy
### stats.protocol
@ -106,10 +106,10 @@ Path to serve stats to, normally `/metrics`.
The [prefix](https://prometheus.io/docs/practices/naming/#metric-names) that nebula should add to stats to add context
within Prometheus. It's recommended to set this to `nebula` by default. Must be in the shape:
<https://prometheus.io/docs/concepts/data_model/>
https://prometheus.io/docs/concepts/data_model/
### stats.subsystem
Describe which sort of subsystem these stats fall into:
<https://prometheus.io/docs/practices/instrumentation/#subsystems>. Must be in the shape:
<https://prometheus.io/docs/concepts/data_model/>
https://prometheus.io/docs/practices/instrumentation/#subsystems. Must be in the shape:
https://prometheus.io/docs/concepts/data_model/

View file

@ -76,7 +76,7 @@ tun:
## tun.unsafe_routes
:::caution
:::warning
The nebula certificate of the `via` node MUST have the `route` defined as a subnet in its certificate or it will refuse
to route traffic.

View file

@ -28,7 +28,7 @@ nebula-cert keygen -out-key alice.key -out-pub alice.pub
This will save the private and public keys to `alice.key` and `alice.pub` respectively.
:::caution
:::warning
The private key, along with certificate you will create below, is what Nebula will use to prove its identity during
handshakes. Do not share this private key with anyone else! It is recommended that you do not copy the private key to

View file

@ -1,6 +1,6 @@
# Using Experimental Lighthouse DNS with Nebula
:::caution
:::warning
Lighthouse DNS in nebula is experimental and should not be considered to be a robust solution. For details, see the
[limitations](#limitations) listed below.
@ -121,7 +121,7 @@ address visible to the internet, only users on your nebula network will be able
100.100.0.2
```
Nebula supports full unicode strings in the host name, but for hosts to be discovered via Lighthouse DNS, they must
conform to the DNS spec. <https://www.punycoder.com/> is a useful tool for conversion.
conform to the DNS spec. https://www.punycoder.com/ is a useful tool for conversion.
- Are the domain names case-sensitive?
- Currently the DNS server matches names case sensitively, though DNS is
[meant to resolve case-insensitively](https://www.rfc-editor.org/rfc/rfc1035#section-2.3.3).

View file

@ -14,21 +14,21 @@
"test": "uvu -r tsm --dir ."
},
"dependencies": {
"@docusaurus/core": "2.3.0",
"@docusaurus/preset-classic": "2.3.0",
"@mdx-js/react": "^1.6.22",
"@docusaurus/core": "3.0.0",
"@docusaurus/preset-classic": "3.0.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^1.2.1",
"parse-domain": "^5.0.0",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2"
"parse-domain": "^7.0.1",
"prism-react-renderer": "^2.1.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "2.3.0",
"@docusaurus/theme-classic": "^2.0.0",
"@docusaurus/types": "^2.0.0",
"@docusaurus/module-type-aliases": "3.0.0",
"@docusaurus/theme-classic": "^3.0.0",
"@docusaurus/types": "^3.0.0",
"@docusaurus/tsconfig": "^3.0.0",
"@ianvs/prettier-plugin-sort-imports": "^3.7.1",
"@tsconfig/docusaurus": "^1.0.6",
"@types/node": "^20.8.10",
"alias-hq": "^6.1.0",
"autoprefixer": "^10.4.13",
@ -37,7 +37,7 @@
"postcss-nesting": "^11.0.0",
"prettier": "^2.8.3",
"tsm": "^2.3.0",
"typescript": "^4.9.4",
"typescript": "^5.2.2",
"uvu": "^0.5.6"
},
"browserslist": {
@ -54,6 +54,6 @@
},
"packageManager": "pnpm@8.10.0+sha256.3c5d70d07b0c4849d7e07398b62bf48ca6619ca86f77981125eaab7f5ee82c4c",
"engines": {
"node": ">=18.16.0"
"node": ">=18"
}
}

2860
pnpm-lock.yaml generated

File diff suppressed because it is too large Load diff

View file

@ -1,6 +1,6 @@
{
// This file is not used in compilation. It is here just for a nice editor experience.
"extends": "@tsconfig/docusaurus/tsconfig.json",
"extends": "@docusaurus/tsconfig",
"compilerOptions": {
"baseUrl": ".",
"incremental": true,