Initial Zillabase Documentation (#20)

* feat: initial docs structure

* add icons

* update cards

* import guides articles

* import cli reference

* feat: integrate scalar for api documentation

* fix broken link

* minor adjustmen

* fix dark mode bug

* some adjustments

* adjust navbar padding

* text align left content

* update icon filter on hover

* fix: update docs per feedback

* update navbar and sidebar

* initial document structure refactor

* add references and update overview card

* update icons on sidebar and overview

* fix api reference width

* fix typo

* update overview descriptions

* update defining table overview

* Workflow for `gitflow-release` & `build & deploy`

* create version.json for workflow (#4)

* `deploy-version.json` file for build (#5)

* Use `ORG_GITHUB_TOKEN` (#6)

* revert github token update (#7)

* update permissions for workflow

* add petstore and faqs

* community support page

* streampay project example

* install mermaid

* fix spacing

* add troubleshooting

* git repo url update (#9)

* list Dist Directory (#11)

* tag update to latest release (#12)

* add verbose to workflows (#13)

* add verbose for `dist` dir (#14)

* verbose (#15)

* import `env.js` for build (#16)

* include `_redirects` (#17)

* remove breadcrumbs on products, remove api reference, rename section

* update `base` url (#18)

* update docs per feedback

* remove zilla card

* CI: update version to 0.0.2

* add articles for storage

* update navbar

* update sidebar and breadcrumb

* update logo

* update sso, revise external java udf

* update sso overview icon

* update quickstart

* update: readme and markdown lint

* feat: add linter and vale configuration, update version

* lint articles

* update: adjust site configuration

* update: add reference, move sso article, add github link

* update text for link

* update: add versions dropdown in navbar

---------

Co-authored-by: Ankit Kumar <[email protected]>
Co-authored-by: ankitk-me <[email protected]>
Co-authored-by: github-actions <[email protected]>

.config/vale/styles/.vale-config/1-Vuepress.ini

@@ -0,0 +1,3 @@
+[*.md]
+# Exclude `{ ... }`
+TokenIgnores = ({ .* })

.config/vale/styles/config/vocabularies/Base/accept.txt

@@ -0,0 +1,145 @@
+(?i)amqp
+(?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
+(?i)middleware
+(?i)MSK
+(?i)namespace
+(?i)nginx
+(?i)otlp
+(?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)?
+args
+async
+Avro
+Bidi
+bitnami
+BOMs
+CA(s)?
+CLI(s)?
+Conduktor
+config
+const
+CQRS
+crv
+cspell
+datagram
+EDAs
+enSidebar
+enum
+etag
+Fargate
+fas
+gitea
+Grafana
+gRPC
+grpcurl
+GSSAPI
+HAProxy
+heroImage
+heroText
+inet
+inkey
+jceks
+jq
+jwt
+Kafka
+Karapace
+kcat
+kty
+leader_only
+Lua
+lycheeverse
+maxLength
+minLength
+MQTT
+mvnw
+netcat
+npm
+OAUTHBEARER
+oneOf
+oneway
+pem
+Petstore
+pkcs12
+Plaintext
+proto
+protobuf
+really
+receive_only
+Redpanda
+remote_server
+repo(s)?
+routeguide
+sasl
+send_and_receive
+send_only
+shortTitle
+simlinks
+stdout
+Syslog
+tcp
+tls
+unix
+UUID(s)
+VPC(s)?
+VPN(s)
+VSCode
+WebSocket
+ws
+yaml
+Zilla
+zlib
+zpm
+zpmw

.config/vale/styles/config/vocabularies/Base/reject.txt

@@ -0,0 +1,3 @@
+(?i)pubic
+bellow
+zilla[^\.\-]

.config/vale/styles/docs/TooWordy.yml

@@ -0,0 +1,207 @@
+extends: existence
+message: "'%s' is too wordy"
+ignorecase: true
+level: error
+tokens:
+  - a number of
+  - abundance
+  - accede to
+  - accelerate
+  - accentuate
+  - accompany
+  - accomplish
+  - accorded
+  - accrue
+  - acquiesce
+  - acquire
+  - adjacent to
+  - adjustment
+  - admissible
+  - advantageous
+  - adversely impact
+  - advise
+  - aforementioned
+  - aggregate
+  - aircraft
+  - all of
+  - all things considered
+  - alleviate
+  - along the lines of
+  - already existing
+  - alternatively
+  - amazing
+  - ameliorate
+  - anticipate
+  - apparent
+  - appreciable
+  - as a matter of fact
+  - as a means of
+  - as far as I'm concerned
+  - as of yet
+  - as to
+  - as yet
+  - ascertain
+  - assistance
+  - at the present time
+  - at this time
+  - attain
+  - attributable to
+  - authorize
+  - because of the fact that
+  - belated
+  - benefit from
+  - bestow
+  - by means of
+  - by virtue of the fact that
+  - by virtue of
+  - cease
+  - close proximity
+  - commence
+  - comply with
+  - concerning
+  - consequently
+  - consolidate
+  - constitutes
+  - demonstrate
+  - depart
+  - designate
+  - discontinue
+  - due to the fact that
+  - each and every
+  - economical
+  - elucidate
+  - employ
+  - endeavor
+  - enumerate
+  - equitable
+  - equivalent
+  - evidenced
+  - exclusively
+  - expedite
+  - expend
+  - expiration
+  - facilitate
+  - factual evidence
+  - feasible
+  - finalize
+  - first and foremost
+  - for all intents and purposes
+  - for the most part
+  - for the purpose of
+  - forfeit
+  - formulate
+  - have a tendency to
+  - honest truth
+  - however
+  - if and when
+  - impacted
+  - in a manner of speaking
+  - in a timely manner
+  - in a very real sense
+  - in accordance with
+  - in addition
+  - in all likelihood
+  - in an effort to
+  - in between
+  - in excess of
+  - in lieu of
+  - in light of the fact that
+  - in many cases
+  - in my opinion
+  - in order to
+  - in regard to
+  - in some instances
+  - in terms of
+  - in the case of
+  - in the event that
+  - in the final analysis
+  - in the nature of
+  - in the near future
+  - in the process of
+  - inception
+  - incumbent upon
+  - indicate
+  - indication
+  - initiate
+  - irregardless
+  - is applicable to
+  - is authorized to
+  - is responsible for
+  - it is essential
+  - it is
+  - it seems that
+  - magnitude
+  - methodology
+  - minimize
+  - modify
+  - necessitate
+  - nevertheless
+  - not certain
+  - not many
+  - not often
+  - not unless
+  - not unlike
+  - notwithstanding
+  - null and void
+  - numerous
+  - objective
+  - obligate
+  - obtain
+  - on the contrary
+  - on the other hand
+  - one particular
+  - optimum
+  - overall
+  - owing to the fact that
+  - participate
+  - particulars
+  - pass away
+  - pertaining to
+  - point in time
+  - portion
+  - possess
+  - preclude
+  - prior to
+  - prioritize
+  - procure
+  - proficiency
+  - provided that
+  - purchase
+  - put simply
+  - readily apparent
+  - refer back
+  - regarding
+  - relocate
+  - remainder
+  - remuneration
+  - reside
+  - residence
+  - retain
+  - satisfy
+  - shall
+  - should you wish
+  - solicit
+  - span across
+  - strategize
+  - subsequent
+  - substantial
+  - successfully complete
+  - sufficient
+  - terminate
+  - the month of
+  - the point I am trying to make
+  - therefore
+  - time period
+  - took advantage of
+  - transmit
+  - transpire
+  - until such time as
+  - utilization
+  - utilize
+  - validate
+  - various different
+  - what I mean to say is
+  - whether or not
+  - with respect to
+  - with the exception of
+  - witnessed

.config/vale/styles/docs/avoid.yml

@@ -0,0 +1,8 @@
+extends: substitution
+message: Use '%s' instead of '%s'
+level: error
+ignorecase: true
+swap:
+  Some of the: Some
+  as following: as follows
+  can not: "can't"