Skip to content

zdrapela/kogito-docs

This branch is 124 commits behind apache/incubator-kie-kogito-docs:main.

Folders and files

NameName
Last commit message
Last commit date
Jul 21, 2023
Aug 21, 2023
Jan 10, 2023
Jun 27, 2023
Jun 22, 2022
Jan 10, 2023
Sep 6, 2023
Jun 27, 2023
Jul 13, 2023
May 9, 2022
Aug 22, 2022
Aug 21, 2023
Sep 4, 2023
Jun 27, 2023
Jun 16, 2022

Repository files navigation

Kogito Guides

The published guides can be found 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 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 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 contributing doc.

About

Kogito Documentation Repository

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 27.6%
  • CSS 25.9%
  • Groovy 18.8%
  • Handlebars 14.7%
  • Python 11.6%
  • Shell 1.4%