Skip to content

Commit

Permalink
Merge branch 'release/v0.7.7' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jan 12, 2024
2 parents e3c7aa6 + d3e0db8 commit edc2280
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 3 deletions.
103 changes: 103 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion deploy-versions.json
Original file line number Diff line number Diff line change
@@ -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"}]
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/reference/aws/create-server-certificate-letsencrypt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit edc2280

Please sign in to comment.