tiagobento opened a new pull request, #6866: URL: https://github.com/apache/incubator-kie-drools/pull/6866
## What This PR reworks the repository's top-level documentation to reflect its role as the main repository of Apache KIE (incubating), and starts a centralized `docs/` directory capturing how the repository itself works. ### New `README.md` Rewritten around Apache KIE as the umbrella for **Drools**, **OptaPlanner**, **jBPM**, and **Kogito**: - A dedicated section per project, each with its logo (Apache KIE logo up top) and a consistent structure: what the engine does, and how its assets are authored. Drools covers all three of its engines — rules (DRL), decisions (DMN/FEEL), and CEP — with links to the DMN and BPMN 2.0 specs, FEEL, Quarkus, and Spring Boot. - **Releases** — official source releases first (downloads page, direct `downloads.apache.org` links, KEYS, verification instructions), then the Maven Central groupIds, the importable BOMs (with a note on why jBPM has no separate BOM — its artifacts are managed by `kogito-bom`), and the shared-version policy. - **Documentation** — pointers to the Apache KIE website docs and the new in-repo `docs/` directory. - **Get involved** — two-level structure: mailing lists (`users@`, `dev@`, `[email protected]` with archive + subscribe links), chat (Zulip, Kogito Google Group), issue trackers (this repository's, plus `apache/incubator-kie-issues`), and a "New to Apache?" list (The Apache Way, newcomers guide, Apache Incubator). - **Building and contributing**, **License**, and the standard incubation disclaimer footer. ### Refreshed `CONTRIBUTING.md` The previous content was still the `kogito-runtimes` contribution guide. It now: - Applies to all four KIE projects, with updated links: shared issue tracker (`apache/incubator-kie-issues`), GitHub Actions CI, `[email protected]` mailing list, Apache KIE Zulip, and the ASF docs repository. - Replaces stale build instructions (`-Dquickly` is kogito-apps-only) with verified ones (`-DskipTests`, `-DquickTests`), linking to `docs/BUILDING.md`. - Absorbs the "Test execution tips" and "Documenting tips" sections previously in `README.md`. ### New `docs/` directory Documentation about how *this repository* works, surfacing repo-wide knowledge that was previously scattered across nested module guides (which are left untouched): | Document | Covers | | --- | --- | | `docs/README.md` | Index of the directory | | `docs/STRUCTURE.md` | Module prefix structure (`drools-`, `optaplanner-`, `kogito-`, `kogito-apps-`), BOM/parent-pom hierarchies | | `docs/BUILDING.md` | Build flags, test profiles (`test-en`, `test-coverage`, `quickTests`), troubleshooting | | `docs/CONVENTIONS.md` | Code style / IDE setup, license headers, SPI mechanisms, codegen and testing conventions | | `docs/PR_CHECKS_AND_CI.md` | The scope-based `CI :: Build` check (reproducible builds, reports, artifacts), the `CI :: Examples` downstream check, license header and split-package checks | | `docs/OTHER_COMPONENTS.md` | Apache KIE components beyond the four main projects: the PMML engine and KIE Tools | | `docs/HISTORY.md` | From Drools (2001), OptaPlanner (2006), and jBPM 5 (2010) at JBoss/Red Hat — including the Guvnor → Business Central lineage, KIE Server, and Red Hat's commercial offerings — through Dashbuilder, TrustyAI, and SonataFlow, to IBM joining in 2022 and KIE entering the Apache Incubator on January 13th, 2023 | | `docs/DEVELOP_ON_MACOS.md` | Moved from the root `Develop_on_Mac.md` and rewritten (SDKMAN!, Homebrew, GraalVM setup) | ### Other - `docsimg/` — Apache KIE, Drools, OptaPlanner, jBPM, and Kogito logos (SVGs from the Apache KIE website). - `.asf.yaml` — GitHub description and labels updated to the umbrella framing; merge commits disabled (squash only). ## Notes for reviewers - `docs/PR_CHECKS_AND_CI.md` documents the CI as of #6862 (build-chain removal), written as the current state. - The README is written for this repository's upcoming rename to `apache/incubator-kie` (clone URLs, issue tracker links) — see [INFRA-28201](https://issues.apache.org/jira/browse/INFRA-28201).. - All facts were verified against the repo and primary sources (Maven profiles, BOM coordinates, groupIds, workflows, the ASF download area, lists.apache.org, the Apache Incubator status page, and the archived July 2022 IBM/Red Hat announcement) rather than carried over from the legacy docs. --- Merge after the repo's been renamed, and after: - #6862 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
