mirror of
https://github.com/apache/incubator-kie-kogito-docs.git
synced 2026-11-06 04:30:22 +00:00
Kogito Documentation Repository
antora
cloudevents
cncf
documentation
guides
hacktoberfest
knative
kogito
kubernetes
serverlessworkflow
- JavaScript 26.9%
- CSS 21.2%
- Groovy 20.7%
- Python 13.6%
- Handlebars 12.2%
- Other 5.4%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
d920f0e6d9
Some checks failed
Publish to GitHub Pages / build (16.x) (push) Has been cancelled
* updated readme and description to archieve repo * updated readme and description to archieve repo * updated docs --------- Co-authored-by: Kusuma <kusuma-latha@ibm.com> |
||
| .ci/jenkins | ||
| .github | ||
| antora | ||
| build/site | ||
| lib | ||
| logos/sonataflow | ||
| scripts | ||
| serverlessworkflow | ||
| .asf.yaml | ||
| .gitignore | ||
| antora-playbook-author.yml | ||
| antora-playbook.yml | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| NOTICE | ||
| package-lock.json | ||
| package.json | ||
| README.adoc | ||
= Kogito Guides [NOTE] ==== *This repository is archived and frozen!* This repository contains the SonataFlow (Serverless Workflow) documentation frozen as of version *10.2.0*. * Branch `10.2.x` and tag `10.2.0` represent the final release state. * The `main` branch is frozen, and no further development or documentation updates will take place in this repository. ==== 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].