https://github.com/apache/incubator-kie-kogito-docs
Kogito Documentation Repository
https://github.com/apache/incubator-kie-kogito-docs
antora cloudevents cncf documentation guides hacktoberfest knative kogito kubernetes serverlessworkflow
Last synced: 2 months ago
JSON representation
Kogito Documentation Repository
- Host: GitHub
- URL: https://github.com/apache/incubator-kie-kogito-docs
- Owner: apache
- License: apache-2.0
- Created: 2022-05-09T17:59:35.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-26T06:41:41.000Z (3 months ago)
- Last Synced: 2025-03-30T03:21:12.061Z (3 months ago)
- Topics: antora, cloudevents, cncf, documentation, guides, hacktoberfest, knative, kogito, kubernetes, serverlessworkflow
- Language: JavaScript
- Homepage: https://kiegroup.github.io/kogito-docs/
- Size: 63.9 MB
- Stars: 12
- Watchers: 35
- Forks: 60
- Open Issues: 37
-
Metadata Files:
- Readme: README.adoc
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
= Kogito Guides
The published guides can be found https://apache.github.io/incubator-kie-kogito-docs/serverlessworkflow/latest/index.html[here].
== Prerequisite
Running Antora with Lunr extension (required to generate self-hosted search) requires Node.js v16.0.0 or above.
== Installing Dependencies
This folder contains `package.json` files that you can use to install dependencies. Run the following command.
----
$ npm install
----
== Building the website locally
This folder contains an antora playbook, `antora-playbook-author.yml` to generate the documentation under the `build` folder.
To install and build the Antora site locally use:
`npm run local-install-build`
To build Antora site when you have already installed `npm` dependencies, use:
`npm run local-build`
== How it works
This module builds a documentation website using https://antora.org/[Antora].
To simplify the maintenance, the documentation website is based on a pre-built default Antora UI bundle
located in `ui-bundle/ui-bundle.zip`. Customizations are located in `supplemental-ui` that Antora uses to replace
parts of the default `ui-bundle.zip`.
== How to upgrade
=== Upgrade UI bundle
Download the latest `ui-bundle.zip` from https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable[Antora GitLab job]
and replace the existing one in the `ui-bundle` directory.
Be aware that the bundle is not versioned and in the future might not be compatible with the customizations this website uses.
== Contributing
Before opening a PR, please read the link:CONTRIBUTING.md[contributing doc].