From 53d1b959e9b72195800fb62a6028388b053f4350 Mon Sep 17 00:00:00 2001 From: Tiago Bento Date: Sun, 10 Nov 2024 13:53:49 -0500 Subject: [PATCH] . --- README.md | 2 +- KOGITO_UPGRADE_PROCESS.md => repo/KOGITO_UPGRADE_PROCESS.md | 0 repo/MANUAL.md | 4 ++-- NIX_DEV_ENV.md => repo/NIX_DEV_ENV.md | 0 4 files changed, 3 insertions(+), 3 deletions(-) rename KOGITO_UPGRADE_PROCESS.md => repo/KOGITO_UPGRADE_PROCESS.md (100%) rename NIX_DEV_ENV.md => repo/NIX_DEV_ENV.md (100%) diff --git a/README.md b/README.md index 9af78d4f2a6..8eb1f047b91 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ This repository contains tooling applications and libraries for KIE projects. > **💡 RECOMMENDED** > -> **Nix development environment**: A _devbox_ configuration is provided to automatically setup all the tools below. Read more in [here](./NIX_DEV_ENV.md). +> **Nix development environment**: A _devbox_ configuration is provided to automatically setup all the tools below. Read more in [here](./repo/NIX_DEV_ENV.md). To build and test all packages of the Apache KIE Tools project, you're going to need: diff --git a/KOGITO_UPGRADE_PROCESS.md b/repo/KOGITO_UPGRADE_PROCESS.md similarity index 100% rename from KOGITO_UPGRADE_PROCESS.md rename to repo/KOGITO_UPGRADE_PROCESS.md diff --git a/repo/MANUAL.md b/repo/MANUAL.md index f283ede6f04..d36f764cb9a 100644 --- a/repo/MANUAL.md +++ b/repo/MANUAL.md @@ -30,7 +30,7 @@ structure, concepts like "packages" and specifics on important tools like Maven, | `repo/`
`scripts/` | Related to the monorepo itself. `repo` contains files describing the monorepo structure (I.e., packages DAG, for enabling partial clones with sparse checkout). `scripts` contains code to make the monorepo run smoothly. (E.g., `update-version-to` or `bootstrap`). | | `docs/`
`gifs/` | Files referenced externally in READMEs, for instance. Could be unified into a single directory only, probably with a better name. | | `package.json`
`pnpm-workspace.yaml` | Together they define the monorepo structure and make some commands available at the root dir. The root `package.json` acts like the glue holding everything together. It declares dependencies that are necessary for the monorepo to operate. Packages inside `scripts` are part of these dependencies. | -| `.envrc`
`devbox.lock`
`devbox.json` | Direnv and Devbox configuration files. See these instructions to set it up. See [NIX_DEV_ENV.md](./../../NIX_DEV_ENV.md) | +| `.envrc`
`devbox.lock`
`devbox.json` | Direnv and Devbox configuration files. See these instructions to set it up. See [NIX_DEV_ENV.md](./NIX_DEV_ENV.md) | | `.ci/` | Jeknins configuration for Apache release jobs | | `.github/` | GitHub configuration | | `.asf.yaml` | Apache Software Foundation (ASF) YAML for configuring GitHub features, as no one has access to the Settings tab of repos under the Apache organization. | @@ -257,7 +257,7 @@ This section contains relevant topics about developing packages hosted on KIE To #### Setting up your environment - Nix.dev, Devbox, and `direnv` _**(recommended!)**_ - - See [NIX_DEV_ENV.md](./../../NIX_DEV_ENV.md) + - See [NIX_DEV_ENV.md](./NIX_DEV_ENV.md) - Traditional - See [the top-level README.md](../../README.md#step-0-install-the-necessary-tools) diff --git a/NIX_DEV_ENV.md b/repo/NIX_DEV_ENV.md similarity index 100% rename from NIX_DEV_ENV.md rename to repo/NIX_DEV_ENV.md