From 2c062b5c6a3bbb83f23be325f32a1fc6b081033a Mon Sep 17 00:00:00 2001 From: AJ Danelz Date: Sat, 6 Jan 2024 10:35:01 -0500 Subject: [PATCH 1/3] Add reference doc creation instructions (#166) --- README.md | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) diff --git a/README.md b/README.md index fc672ccf..fa9862e4 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,109 @@ pnpm dev pnpm link-checker && lychee --exclude-mail --base="src/.vuepress/dist" src/.vuepress/dist ``` +### Reference docs Structure + +Pages in the reference section describe, as briefly as possible and in an orderly way, the properties and interface of a feature. + +- h1(#) - Title + - Include description and Full example codeblock +- h2(##) - Page section +- h3-6 - Properties + - h3(###) - Top level + - Top level props should(not mandatory) include an addition codeblock example including the entire example + - h4-6 - Header level correlates with path depth + - Child property headers reference the parent + - `#### parent.child` + - Arrays of objects have brackets `[]` only when describing child properties + - `#### parentArray[].child` + +Table of Contents (ToC) anchor links are generated using the [Markdown All in One](https://markdown-all-in-one.github.io/docs/guide/table-of-contents.html#overview) extension with the `gitea` slug mode. + +- Required props have an escaped splat `\*` at the end of the header and ToC link + - `### topLevelProp\*` + - `- [topLevelProp\*](#toplevelprop)` + +````markdown +# Title + +Description. + +```yaml +topLevelProp: + child: example +array: + - one + - two +parentArray: + - child: one + - child: two +``` + +## Section + +:::: note ToC + +- [topLevelProp\*](#toplevelprop) + - [topLevelProp.child\*](#toplevelprop-child) +- [array](#array) +- [parentArray](#parentarray) + - [parentArray\[\].child](#parentarray-child) + +::: right +\* required +::: + +:::: + +### topLevelProp\* + +> `object` + +Description. + +```yaml +topLevelProp: + child: example +``` + +#### topLevelProp.child\* + +> `type` | Default: `value` + +Description. + +### array + +> `array` of `primitive` + +Description. + +```yaml +array: + - one + - two +``` + +### parentArray + +> `array` of `object` + +Description. + +```yaml +parentArray: + - child: one + - child: two +``` + +#### parentArray[].child + +> `type` + +Description. + +```` + ## Provide feedback We’d love to hear your feedback. Please file documentation issues only in the docs GitHub repository. You can file a new issue to suggest improvements or if you see any errors in the existing documentation. From 3ae7d9a17a8dd3b8ec3af315a2ea170e3be6f22b Mon Sep 17 00:00:00 2001 From: AJ Danelz Date: Fri, 12 Jan 2024 11:32:23 -0500 Subject: [PATCH 2/3] specify key type rsa (#169) --- src/reference/aws/create-server-certificate-letsencrypt.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/reference/aws/create-server-certificate-letsencrypt.md b/src/reference/aws/create-server-certificate-letsencrypt.md index df09c0e6..f9a70019 100644 --- a/src/reference/aws/create-server-certificate-letsencrypt.md +++ b/src/reference/aws/create-server-certificate-letsencrypt.md @@ -19,7 +19,7 @@ sudo yum install -y certbot Then issue the wildcard certificate such as `*.example.aklivity.io`. ```bash:no-line-numbers -sudo certbot -d *.example.aklivity.io --manual --preferred-challenges dns certonly +sudo certbot -d *.example.aklivity.io --manual --preferred-challenges dns --key-type rsa certonly ``` This will require you to respond to the challenge by adding a custom DNS record proving ownership of the wildcard domain, such as `*.example.aklivity.io`. From d3e0db8a96b9430915efdc620cac6564d7960537 Mon Sep 17 00:00:00 2001 From: vordimous Date: Fri, 12 Jan 2024 17:00:12 +0000 Subject: [PATCH 3/3] CI: update version to 0.7.7 --- deploy-versions.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/deploy-versions.json b/deploy-versions.json index d0de842b..f46d6770 100644 --- a/deploy-versions.json +++ b/deploy-versions.json @@ -1 +1 @@ -[{"text":"Latest","icon":"fas fa-home","key":"latest","tag":"v0.7.6"}] +[{"text":"Latest","icon":"fas fa-home","key":"latest","tag":"v0.7.7"}] diff --git a/package.json b/package.json index 52f5d263..5badd504 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "zilla-docs", - "version": "0.7.6", + "version": "0.7.7", "description": "The official documentation for the aklivity/zilla open-source project", "keywords": [], "author": "aklivity.io",