This is an automated email from the ASF dual-hosted git repository.
dhanak pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-kie-website.git
The following commit(s) were added to refs/heads/main by this push:
new 686a57b kie-issues#1803: [10.0.0] Fix missing documentation for
10.0.0 (#18)
686a57b is described below
commit 686a57bf48c980100e84f43edb89c3cacb3cdbfa
Author: Dominik Hanák <[email protected]>
AuthorDate: Tue Feb 18 14:33:31 2025 +0100
kie-issues#1803: [10.0.0] Fix missing documentation for 10.0.0 (#18)
* Initial setup for Documentation section
* Remove unnecesarry space and newlines
* Try to update the deploy workflow to build sonataflow-docs too
* TEMPORARY: Showcase sonataflow-docs embed
* Fix Build Apache Kie Website step
* Include Pr preview
* Revert "TEMPORARY: Showcase sonataflow-docs embed"
This reverts commit 77e9902c6f1a6076b7b17dbb01525e1fbef22938.
* Include Sonataflow Iframe
* Remove bracnches for pull_request
* Fix bad equal sign
* Fix typo
* Improve how we include the docs, use href now
* Include drools-docs and fix the deploy wf
* Fix publish_dir in preview step
* Remove not working previews and add artifact upload for PR
* Fix lowercase F in SonataFlow
* Add Contribute section to README
* Add Kogito to deploy workflow
* Include & link to KOGITO documentation
* Remove jBPM mention, jBPM is part of Kogito
* Fix location of built kogito docs
---
.github/workflows/deploy.yml | 81 ++++++++++++++++++++++++++---
README.md | 5 ++
docs/documentation/documentation.md | 22 ++++++++
docs/documentation/documentation_10.0.0.mdx | 29 +++++++++++
docusaurus.config.ts | 6 +++
sidebars.ts | 1 +
6 files changed, 136 insertions(+), 8 deletions(-)
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index bdda5ff..53ff78e 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -10,16 +10,81 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
- - uses: actions/setup-node@v4
+ - name: Checkout SonataFlow repository
+ uses: actions/checkout@v4
with:
- node-version: 18.x
- - run: npm install
- - run: npm run build
- - run: cp .asf.yaml build/.asf.yaml
- - uses: peaceiris/actions-gh-pages@v3
+ repository: apache/incubator-kie-kogito-docs
+ ref: 10.0.x
+ path: sonataflow-docs
+
+ - name: Build Sonataflow documentation
+ run: |
+ cd sonataflow-docs
+ npm run install-build
+
+ - name: Checkout Drools repository
+ uses: actions/checkout@v4
+ with:
+ repository: apache/incubator-kie-drools
+ ref: 10.0.x
+ path: drools
+
+ - name: Build Drools documentation
+ run: |
+ cd drools/drools-docs
+ mvn -B clean install
+
+ - name: Checkout Kogito documentation repository
+ uses: actions/checkout@v4
+ with:
+ repository: apache/incubator-kie-docs
+ ref: 10.0.x
+ path: kogito-docs
+
+ - name: Build Kogito documentation
+ run: |
+ cd kogito-docs
+ mvn -B clean install -Dfull
+
+ - name: Checkout Apache KIE Website repository
+ uses: actions/checkout@v4
+ with:
+ path: incubator-kie-website
+
+ - name: Copy Sonataflow docs to Apache KIE static folder
+ run: |
+ mkdir -p incubator-kie-website/static/sonataflow-docs
+ cp -r sonataflow-docs/build/site/*
incubator-kie-website/static/sonataflow-docs
+
+ - name: Copy Drools docs to Apache KIE static folder
+ run: |
+ mkdir -p incubator-kie-website/static/drools-docs
+ cp -r drools/drools-docs/target/website/docs/*
incubator-kie-website/static/drools-docs
+
+ - name: Copy Kogito docs to Apache KIE static folder
+ run: |
+ mkdir -p incubator-kie-website/static/kogito-docs
+ cp -r
kogito-docs/doc-content/apache-kie-kogito/target/generated-docs/html_single/*
incubator-kie-website/static/kogito-docs
+
+ - name : Build Apache Kie Website
+ run: |
+ cd incubator-kie-website
+ npm install
+ npm run build
+ cp .asf.yaml build/.asf.yaml
+
+ - name: Archive Apache KIE Website for preview
+ uses: actions/upload-artifact@v4
+ if: github.event_name == 'pull_request'
+ with:
+ name: apache-kie-website
+ path: incubator-kie-website/build
+ overwrite: true
+
+ - name: Deploy Apache KIE Website
+ uses: peaceiris/actions-gh-pages@v3
if: github.event_name != 'pull_request'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
- publish_dir: ./build
+ publish_dir: incubator-kie-website/build
publish_branch: deploy
diff --git a/README.md b/README.md
index 515b0f5..21e12d2 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,11 @@ $ yarn build
This command generates static content into the `build` directory and can be
served using any static contents hosting service.
+
+### Contribute
+
+Contributions are welcome, any pull request that is merged will be
automatically deployed to live website.
+
## LICENSE
Apache License 2.0
diff --git a/docs/documentation/documentation.md
b/docs/documentation/documentation.md
new file mode 100644
index 0000000..ae35a5b
--- /dev/null
+++ b/docs/documentation/documentation.md
@@ -0,0 +1,22 @@
+---
+id: documentation
+title: Documetation
+sidebar_position: 0
+---
+
+# Documentation
+
+Apache KIE (incubating) provides live documentation for community in two
streams.
+
+1. Development stream - built & published nightly from `main` branch. Usage is
limited to testing and development.
+2. Release stream - built & published after the vote on release canidates
passes. We will maintain each released branch until it is deprecated.
+
+## Source
+
+The source of our documentation is hosted at Github, across multiple
repostories.
+
+See the instructions on how to contribute and build from source by examing the
link below.
+
+* [Drools
Documentation](https://github.com/apache/incubator-kie-drools/tree/main/drools-docs)
+* [Kogito
Documentation](https://github.com/apache/incubator-kie-docs/tree/main/doc-content/apache-kie-kogito)
+* [SonataFlow
Documentation](https://github.com/apache/incubator-kie-kogito-docs/tree/main)
diff --git a/docs/documentation/documentation_10.0.0.mdx
b/docs/documentation/documentation_10.0.0.mdx
new file mode 100644
index 0000000..bc6c093
--- /dev/null
+++ b/docs/documentation/documentation_10.0.0.mdx
@@ -0,0 +1,29 @@
+---
+id: documentation_10.0.0
+title: 10.0.0
+sidebar_position: 1
+---
+
+# Documentation for release 10.0.0
+
+## Source
+
+The source of our documentation is hosted at Github, across multiple
repostories.
+
+See the instructions on how to contribute and build from source by examing the
link below.
+
+* [Drools
Documentation](https://github.com/apache/incubator-kie-drools/tree/10.0.x/drools-docs)
+* [Kogito
Documentation](https://github.com/apache/incubator-kie-docs/tree/10.0.x/doc-content/apache-kie-kogito)
+* [SonataFlow
Documentation](https://github.com/apache/incubator-kie-kogito-docs/tree/10.0.x/)
+
+## Drools documentation
+
+<p>Click <a href="../../drools-docs" target="_blank" rel="noopener
noreferrer">here</a> to learn about Drools.</p>
+
+## Kogito documentation
+
+<p>Click <a href="../../kogito-docs" target="_blank" rel="noopener
noreferrer">here</a> to learn about Kogito.</p>
+
+## SonataFlow documentation
+
+<p>Click <a href="../../sonataflow-docs" target="_blank" rel="noopener
noreferrer">here</a> to learn about SonataFlow.</p>
\ No newline at end of file
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index 244eb8c..da81b39 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -53,6 +53,12 @@ const config: Config = {
src: "img/navbar-logo.svg",
},
items: [
+ {
+ type: "docSidebar",
+ sidebarId: "documentationSidebar",
+ position: "right",
+ label: "Documentation",
+ },
{
type: "docSidebar",
sidebarId: "downloadSidebar",
diff --git a/sidebars.ts b/sidebars.ts
index 4d1f9fc..16064c5 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -13,6 +13,7 @@ import type { SidebarsConfig } from
"@docusaurus/plugin-content-docs";
const sidebars: SidebarsConfig = {
// By default, Docusaurus generates a sidebar from the docs folder structure
examplesSidebar: [{ type: "autogenerated", dirName: "examples"}],
+ documentationSidebar: [{ type: "autogenerated", dirName: "documentation" }],
downloadSidebar: [{ type: "autogenerated", dirName: "start" }],
communitySidebar: [{ type: "autogenerated", dirName: "community" }]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
