Skip to content

Commit

Permalink
Merge branch 'release/v2.0.0' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Jul 13, 2024
2 parents 3784ce7 + a4cebc0 commit bb6d600
Show file tree
Hide file tree
Showing 83 changed files with 3,794 additions and 1,958 deletions.
27 changes: 27 additions & 0 deletions .config/vale/styles/Vocab/Base/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,27 @@
(?i)arn(s)?
(?i)artifacthub
(?i)cleartext
(?i)cloudformation
(?i)cloudwatch
(?i)config
(?i)confluentinc
(?i)contentId
(?i)datacenter
(?i)declaratively
(?i)docsearch
(?i)fanout
(?i)fontawesome
(?i)globalId
(?i)homebrew
(?i)hostname
(?i)http
(?i)http
(?i)https
(?i)idempotency
(?i)json
(?i)jwt
(?i)kafkacat
(?i)karapace
(?i)Kerberos
(?i)keystore
(?i)keytool
Expand All @@ -26,24 +33,34 @@
(?i)overprovisioned
(?i)param(s)?
(?i)prometheus
(?i)proxied
(?i)proxying
(?i)quickstart(s)?
(?i)realtime
(?i)secretId
(?i)sharding
(?i)sse
(?i)subnet(s)?
(?i)syslog
(?i)teardown
(?i)todo
(?i)trustcacerts
(?i)truststore
(?i)udp
(?i)unencrypted
(?i)unicode
(?i)url
(?i)urls
(?i)vuepress
(?i)wireshark
(?i)yaml
acks
Aiven
Aklivity
alpn
API(s)?
async
Avro
Bidi
bitnami
BOMs
Expand All @@ -55,14 +72,17 @@ const
CQRS
cspell
datagram
EDAs
enSidebar
enum
etag
fas
gitea
Grafana
gRPC
grpcurl
GSSAPI
HAProxy
heroImage
heroText
inet
Expand All @@ -71,8 +91,10 @@ jceks
jq
jwt
Kafka
Karapace
kcat
leader_only
Lua
lycheeverse
MQTT
mvnw
Expand All @@ -81,7 +103,10 @@ npm
OAUTHBEARER
oneOf
oneway
pem
Petstore
pkcs12
Plaintext
proto
protobuf
really
Expand All @@ -96,11 +121,13 @@ send_only
shortTitle
simlinks
stdout
Syslog
tcp
tls
unix
UUID(s)
VPC(s)?
VPN(s)
VSCode
WebSocket
ws
Expand Down
10 changes: 5 additions & 5 deletions .github/contributing/writing-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,15 @@ Your users need reference material because they need truth and certainty - firm

Links to other md files should use the local files path reference to the new document in order for any file render to correctly add links.

- `[grpc-kafka](../../reference/config/bindings/binding-grpc-kafka.md)`
- `[grpc-kafka](../path/to/bindings/binding-grpc-kafka.md)`

When referencing specific attributes of the Zilla api always use and highlight the syntactically correct words found in the reference docs or config. Add any extra descriptive words before or after.

- `[grpc-kafka](../../reference/config/bindings/binding-grpc-kafka.md) Binding`
- `[jwt](../../reference/config/guards/guard-jwt.md) Guard`
- `[produce capability](../../reference/config/bindings/binding-grpc-kafka.md#produce-capability)`
- `[grpc-kafka](../path/to/bindings/binding-grpc-kafka.md) Binding`
- `[jwt](../path/to/guards/guard-jwt.md) Guard`
- `[produce capability](../path/to/bindings/binding-grpc-kafka.md#produce-capability)`

[Reference-style links](https://www.markdownguide.org/basic-syntax/#reference-style-links) should only be used to clarify reading the raw text document when it is needed. This should be used in lists, tables, or complicated paragraphs. When used the reference definition should be placed in a group with other references and as close the the usage as makes sense. Exact highlighted context should be used unless there is a case when reuse of the same link is needed in the same section.
[Reference-style links](https://www.markdownguide.org/basic-syntax/#reference-style-links) should only be used to clarify reading the raw text document when it is needed. This should be used in lists, tables, or complicated paragraphs. When used the reference definition should be placed in a group with other references and as close the usage as makes sense. Exact highlighted context should be used unless there is a case when reuse of the same link is needed in the same section.

Good examples improve readability without adding extra work for a plain text reader:

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/links-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 18
node-version: 20
cache: pnpm

- name: Build VuePress site
Expand Down
4 changes: 4 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ www.twitter.com/aklivityinc
amazonaws.com
hub.docker.com
.+\.name

# These should be removed once the docsearch plugin is fixed
.+/assets/style.+
.+/assets/docsearch.+
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":"v1.2.2"}]
[{"text":"Latest","icon":"fas fa-home","key":"latest","tag":"v2.0.0"}]
25 changes: 13 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "zilla-docs",
"version": "1.2.2",
"version": "2.0.0",
"description": "The official documentation for the aklivity/zilla open-source project",
"keywords": [],
"author": "aklivity.io",
Expand All @@ -15,24 +15,25 @@
"clean-dev": "vuepress-vite dev src --clean-cache",
"dev": "vuepress-vite dev src",
"update-package": "pnpm add -g pnpm && pnpm dlx vp-update",
"lint": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" \"#.config\"",
"lint-fix": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" \"#.config\"",
"lint": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" \"#.config\" \"#.check-schema\"",
"lint-fix": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" \"#.config\" \"#.check-schema\"",
"link-checker": "pnpm build && link-checker src/.vuepress/dist",
"check-schema": "node ./.check-schema"
},
"devDependencies": {
"@vuepress/bundler-vite": "2.0.0-rc.7",
"@vuepress/plugin-catalog": "2.0.0-rc.14",
"@vuepress/plugin-docsearch": "2.0.0-rc.14",
"@vuepress/plugin-prismjs": "2.0.0-rc.15",
"@vuepress/plugin-google-analytics": "2.0.0-rc.15",
"@vuepress/plugin-register-components": "2.0.0-rc.14",
"@vuepress/bundler-vite": "2.0.0-rc.13",
"@vuepress/plugin-catalog": "2.0.0-rc.36",
"@vuepress/plugin-docsearch": "2.0.0-rc.36",
"@vuepress/plugin-google-analytics": "2.0.0-rc.34",
"@vuepress/plugin-prismjs": "2.0.0-rc.36",
"@vuepress/plugin-register-components": "2.0.0-rc.34",
"link-checker": "^1.4.2",
"markdownlint-cli2": "^0.8.1",
"mathjax-full": "^3.2.2",
"vue": "^3.4.26",
"vuepress": "2.0.0-rc.7",
"vuepress-theme-hope": "2.0.0-rc.38"
"mermaid": "^10.9.1",
"vue": "^3.4.29",
"vuepress": "2.0.0-rc.13",
"vuepress-theme-hope": "2.0.0-rc.49"
},
"pnpm": {
"overrides": {
Expand Down
Loading

0 comments on commit bb6d600

Please sign in to comment.