From 6d9c574269c4a2bbd5c0daf0510cd84560aa4296 Mon Sep 17 00:00:00 2001 From: Alexandre Dutra Date: Wed, 26 Jun 2024 17:32:39 +0200 Subject: [PATCH 1/9] Site: display download options for each artifact in tabs ... also include more download options from Maven Central. --- site/docs/downloads/index.md | 250 +++++++++++++++++++++++++--------- site/in-dev/index-release.md | 251 ++++++++++++++++++++++++++--------- site/in-dev/index.md | 58 ++++---- 3 files changed, 415 insertions(+), 144 deletions(-) diff --git a/site/docs/downloads/index.md b/site/docs/downloads/index.md index 7a46629f21b..9b65ed305a8 100644 --- a/site/docs/downloads/index.md +++ b/site/docs/downloads/index.md @@ -22,135 +22,253 @@ See also the [Nessie release page page for version {{ versions.nessie }} on GitH The main Nessie server serves the Nessie repository using the Iceberg REST API and Nessie's native REST API. -### Docker image +=== "Docker Image" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Docker images are multiplatform images for amd64, arm64, ppc64le and s390x. + They are available from the following repositories: + + * [GitHub Container Registry](https://ghcr.io/projectnessie/nessie): -=== "GitHub Container Registry" - [GitHub Container Registry](https://ghcr.io/projectnessie/nessie) ```bash docker pull ghcr.io/projectnessie/nessie:{{ versions.nessie }} docker run -p 19120:19120 -p 9000:9000 ghcr.io/projectnessie/nessie:{{ versions.nessie }} ``` -=== "Quay.io" - [quay.io](https://quay.io/repository/projectnessie/nessie?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie?tab=tags): + ```bash docker pull quay.io/projectnessie/nessie:{{ versions.nessie }} docker run -p 19120:19120 -p 9000:9000 quay.io/projectnessie/nessie:{{ versions.nessie }} ``` -### Helm Chart +=== "Helm Chart" -=== "Artifact Hub" - [Artifact Hub](https://artifacthub.io/packages/search?repo=nessie) -=== "Nessie Helmchart Repo" - [https://charts.projectnessie.org/](https://charts.projectnessie.org/) -=== "Tarball" - [Nessie {{ versions.nessie }} Helm Chart](https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-helm-{{ versions.nessie }}.tgz) + Nessie {{ versions.nessie }} Helm chart is available from the following locations: -### Standalone uber jar + * [Nessie Helm Repo](https://charts.projectnessie.org/): + + ```bash + helm repo add nessie https://charts.projectnessie.org/ + helm repo update + helm install my-nessie nessie/nessie --version "{{ versions.nessie }}" + ``` + + * [Artifact Hub](https://artifacthub.io/packages/helm/nessie/nessie). + * [Nessie {{ versions.nessie }} Helm Chart Tarball](https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-helm-{{ versions.nessie }}.tgz). + +=== "Standalone Jar" + + Requires Java 17 or newer. + + ```bash + curl -L -o nessie-quarkus-{{ versions.nessie }}-runner.jar \ + https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-quarkus-{{ versions.nessie }}-runner.jar + java -jar nessie-quarkus-{{ versions.nessie }}-runner.jar + ``` + +=== "Maven Central" -Requires Java 17 or newer. + * [Nessie Server on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-quarkus/{{ versions.nessie }}/runner) -```bash -curl -L -o nessie-quarkus-{{ versions.nessie }}-runner.jar \ - https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-quarkus-{{ versions.nessie }}-runner.jar -java -jar nessie-quarkus-{{ versions.nessie }}-runner.jar -``` + * Gradle Kotlin snippet: + + ```kotlin + implementation("org.projectnessie.nessie:nessie-quarkus:{{ versions.nessie }}:runner") + ``` + + * Maven snippet: + + ```xml + + org.projectnessie.nessie + nessie-quarkus + {{ versions.nessie }} + + ``` + + * Download all dependencies with Maven: + + ```bash + mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-quarkus:{{ versions.nessie }}:jar:runner + ``` ## Nessie CLI & REPL [Nessie CLI](/nessie-latest/cli/) is both a command-line interface but primarily a REPL. -### Docker image +=== "Standalone Jar" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Requires Java 11 or newer. + + ```bash + curl -L -o nessie-cli-{{ versions.nessie }}.jar \ + https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-cli-{{ versions.nessie }}.jar + java -jar nessie-cli-{{ versions.nessie }}.jar + ``` + +=== "Docker Image" + + Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + They are available from the following repositories: + + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-cli): -=== "GitHub Container Registry" - [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-cli) ```bash docker pull ghcr.io/projectnessie/nessie-cli:{{ versions.nessie }} docker run -it ghcr.io/projectnessie/nessie-cli:{{ versions.nessie }} ``` -=== "Quay.io" - [quay.io](https://quay.io/repository/projectnessie/nessie-cli?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie-cli?tab=tags): + ```bash docker pull quay.io/projectnessie/nessie-cli:{{ versions.nessie }} docker run -it quay.io/projectnessie/nessie-cli:{{ versions.nessie }} ``` -### Standalone uber jar +=== "Maven Central" + + * [Nessie CLI on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-cli/{{ versions.nessie }}/jar) + + * Gradle Kotlin snippet: + + ```kotlin + implementation("org.projectnessie.nessie:nessie-cli:{{ versions.nessie }}") + ``` + + * Maven snippet: -Requires Java 11 or newer. + ```xml + + org.projectnessie.nessie + nessie-cli + {{ versions.nessie }} + + ``` + + * Download all dependencies with Maven: -```bash -curl -L -o nessie-cli-{{ versions.nessie }}.jar \ - https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-cli-{{ versions.nessie }}.jar -java -jar nessie-cli-{{ versions.nessie }}.jar -``` + ```bash + mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-cli:{{ versions.nessie }}:jar + ``` ## Nessie GC Tool [Nessie GC](/nessie-latest/gc/) allows mark and sweep data files based on flexible expiration policies. -### Docker image +=== "Docker Image" + + Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + They are available from the following repositories: -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-gc): -=== "GitHub Container Registry" - [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-gc) ```bash docker pull ghcr.io/projectnessie/nessie-gc:{{ versions.nessie }} docker run ghcr.io/projectnessie/nessie-gc:{{ versions.nessie }} --help ``` -=== "Quay.io" - [quay.io](https://quay.io/repository/projectnessie/nessie-gc?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie-gc?tab=tags): + ```bash docker pull quay.io/projectnessie/nessie-gc:{{ versions.nessie }} docker run quay.io/projectnessie/nessie-gc:{{ versions.nessie }} --help ``` -### Standalone uber jar +=== "Standalone Jar" + + Requires Java 11, Java 17 recommended. + + ```bash + curl -L -o nessie-gc-{{ versions.nessie }}.jar \ + https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-gc-{{ versions.nessie }}.jar + java -jar nessie-gc-{{ versions.nessie }}.jar + ``` + +=== "Maven Central" + + * [Nessie GC on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie-integrations/nessie-gc-tool/{{ versions.nessie }}/jar) + + * Gradle Kotlin snippet: + + ```kotlin + implementation("org.projectnessie.nessie-integrations:nessie-gc-tool:{{ versions.nessie }}") + ``` + + * Maven snippet: + + ```xml + + org.projectnessie.nessie-integrations + nessie-gc-tool + {{ versions.nessie }} + + ``` -Requires Java 11, Java 17 recommended. + * Download all dependencies with Maven: -```bash -curl -L -o nessie-gc-{{ versions.nessie }}.jar \ - https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-gc-{{ versions.nessie }}.jar -java -jar nessie-gc-{{ versions.nessie }}.jar -``` + ```bash + mvn dependency:get -Dartifact=org.projectnessie.nessie-integrations:nessie-gc-tool:{{ versions.nessie }}:jar + ``` ## Nessie Server Admin Tool Nessie's [Server Admin Tool](/nessie-latest/export-import/) allows migration (export/import) of a Nessie repository. -### Docker image +=== "Docker Image" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + They are available from the following repositories: + + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin) -=== "GitHub Container Registry" - [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin) ```bash docker pull ghcr.io/projectnessie/nessie-server-admin:{{ versions.nessie }} docker run ghcr.io/projectnessie/nessie-server-admin:{{ versions.nessie }} --help ``` -=== "Quay.io" - [quay.io](https://quay.io/repository/projectnessie/nessie-server-admin?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie-server-admin?tab=tags) + ```bash docker pull quay.io/projectnessie/nessie-server-admin:{{ versions.nessie }} docker run quay.io/projectnessie/nessie-server-admin:{{ versions.nessie }} --help ``` -### Standalone uber jar +=== "Standalone Jar" -Requires Java 17 or newer. + Requires Java 17 or newer. + + ```bash + curl -L -o nessie-server-admin-tool-{{ versions.nessie }}-runner.jar \ + https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-server-admin-tool-{{ versions.nessie }}-runner.jar + java -jar nessie-server-admin-tool-{{ versions.nessie }}-runner.jar + ``` + +=== "Maven Central" + + * [Nessie Server Admin Tool on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-server-admin-tool/{{ versions.nessie }}/runner) -```bash -curl -L -o nessie-server-admin-tool-{{ versions.nessie }}-runner.jar \ - https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-server-admin-tool-{{ versions.nessie }}-runner.jar -java -jar nessie-server-admin-tool-{{ versions.nessie }}-runner.jar -``` + * Gradle Kotlin snippet: + + ```kotlin + implementation("org.projectnessie.nessie:nessie-server-admin-tool:{{ versions.nessie }}:runner") + ``` + + * Maven snippet: + + ```xml + + org.projectnessie.nessie + nessie-server-admin-tool + {{ versions.nessie }} + + ``` + + * Download all dependencies with Maven: + + ```bash + mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-server-admin-tool:{{ versions.nessie }}:jar + ``` ## Nessie REST API @@ -161,7 +279,19 @@ java -jar nessie-server-admin-tool-{{ versions.nessie }}-runner.jar ## Nessie artifacts on Maven Central -[Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie) +Artifacts are available in two groups: `org.projectnessie.nessie` and +`org.projectnessie.nessie-integrations`. Most users will only need the `org.projectnessie.nessie` +group, which contains the Nessie server and CLI. The `org.projectnessie.nessie-integrations` group +contains additional tools and integrations: + +* Spark extensions +* Nessie GC tool + +Useful links: + +* [Nessie {{ versions.nessie }} BOM (Bill of Materials)](https://search.maven.org/artifact/org.projectnessie.nessie/nessie/{{ versions.nessie }}/pom) +* [Nessie {{ versions.nessie }} `org.projectnessie.nessie` artifacts](https://search.maven.org/search?q=g:org.projectnessie.nessie%20v:{{ versions.nessie }}) +* [Nessie {{ versions.nessie }} `org.projectnessie.nessie-integrations` artifacts](https://search.maven.org/search?q=g:org.projectnessie.nessie-integrations%20v:{{ versions.nessie }}) ## License Reports diff --git a/site/in-dev/index-release.md b/site/in-dev/index-release.md index aa80ba1db17..b5653897f72 100644 --- a/site/in-dev/index-release.md +++ b/site/in-dev/index-release.md @@ -21,135 +21,254 @@ GitHub [release page](https://github.com/projectnessie/nessie/releases/tag/nessi The main Nessie server serves the Nessie repository using the Iceberg REST API and Nessie's native REST API. -### Docker image +=== "Docker Image" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Docker images are multiplatform images for amd64, arm64, ppc64le and s390x. + They are available from the following repositories: + + * [GitHub Container Registry](https://ghcr.io/projectnessie/nessie): -=== "GitHub Container Registry" - [GitHub Container Registry](https://ghcr.io/projectnessie/nessie) ```bash docker pull ghcr.io/projectnessie/nessie:::NESSIE_VERSION:: docker run -p 19120:19120 -p 9000:9000 ghcr.io/projectnessie/nessie:::NESSIE_VERSION:: ``` -=== "Quay.io" - [quay.io](https://quay.io/repository/projectnessie/nessie?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie?tab=tags): + ```bash docker pull quay.io/projectnessie/nessie:::NESSIE_VERSION:: docker run -p 19120:19120 -p 9000:9000 quay.io/projectnessie/nessie:::NESSIE_VERSION:: ``` -### Helm Chart +=== "Helm Chart" -=== "Artifact Hub" - [Artifact Hub](https://artifacthub.io/packages/search?repo=nessie) -=== "Nessie Helmchart Repo" - [https://charts.projectnessie.org/](https://charts.projectnessie.org/) -=== "Tarball" - [Nessie ::NESSIE_VERSION:: Helm Chart](https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-helm-::NESSIE_VERSION::.tgz) + Nessie ::NESSIE_VERSION:: Helm chart is available from the following locations: -### Standalone uber jar + * [Nessie Helm Repo](https://charts.projectnessie.org/): + + ```bash + helm repo add nessie https://charts.projectnessie.org/ + helm repo update + helm install my-nessie nessie/nessie --version "::NESSIE_VERSION::" + ``` + + * [Artifact Hub](https://artifacthub.io/packages/helm/nessie/nessie). + * [Nessie ::NESSIE_VERSION:: Helm Chart Tarball](https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-helm-::NESSIE_VERSION::.tgz). + +=== "Standalone Jar" + + Requires Java 17 or newer. + + ```bash + curl -L -o nessie-quarkus-::NESSIE_VERSION::-runner.jar \ + https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-quarkus-::NESSIE_VERSION::-runner.jar + java -jar nessie-quarkus-::NESSIE_VERSION::-runner.jar + ``` + +=== "Maven Central" -Requires Java 17 or newer. + * [Nessie Server on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-quarkus/::NESSIE_VERSION::/runner) -```bash -curl -L -o nessie-quarkus-::NESSIE_VERSION::-runner.jar \ - https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-quarkus-::NESSIE_VERSION::-runner.jar -java -jar nessie-quarkus-::NESSIE_VERSION::-runner.jar -``` + * Gradle Kotlin snippet: + + ```kotlin + implementation("org.projectnessie.nessie:nessie-quarkus:::NESSIE_VERSION:::runner") + ``` + + * Maven snippet: + + ```xml + + org.projectnessie.nessie + nessie-quarkus + ::NESSIE_VERSION:: + + ``` + + * Download all dependencies with Maven: + + ```bash + mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-quarkus:::NESSIE_VERSION:::jar:runner + ``` ## Nessie CLI & REPL [Nessie CLI](cli.md) is both a command-line interface but primarily a REPL. -### Docker image +=== "Standalone Jar" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Requires Java 11 or newer. + + ```bash + curl -L -o nessie-cli-::NESSIE_VERSION::.jar \ + https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-cli-::NESSIE_VERSION::.jar + java -jar nessie-cli-::NESSIE_VERSION::.jar + ``` + +=== "Docker Image" + + Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + + They are available from the following repositories: + + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-cli): -=== "GitHub Container Registry" - [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-cli) ```bash docker pull ghcr.io/projectnessie/nessie-cli:::NESSIE_VERSION:: docker run -it ghcr.io/projectnessie/nessie-cli:::NESSIE_VERSION:: ``` -=== "Quay.io" - [quay.io](https://quay.io/repository/projectnessie/nessie-cli?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie-cli?tab=tags): + ```bash docker pull quay.io/projectnessie/nessie-cli:::NESSIE_VERSION:: docker run -it quay.io/projectnessie/nessie-cli:::NESSIE_VERSION:: ``` -### Standalone uber jar +=== "Maven Central" -Requires Java 11 or newer. + * [Nessie CLI on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-cli/::NESSIE_VERSION::/jar) -```bash -curl -L -o nessie-cli-::NESSIE_VERSION::.jar \ - https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-cli-::NESSIE_VERSION::.jar -java -jar nessie-cli-::NESSIE_VERSION::.jar -``` + * Gradle Kotlin snippet: + + ```kotlin + implementation("org.projectnessie.nessie:nessie-cli:::NESSIE_VERSION::") + ``` + + * Maven snippet: + + ```xml + + org.projectnessie.nessie + nessie-cli + ::NESSIE_VERSION:: + + ``` + + * Download all dependencies with Maven: + + ```bash + mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-cli:::NESSIE_VERSION:::jar + ``` ## Nessie GC Tool [Nessie GC](gc.md) allows mark and sweep data files based on flexible expiration policies. -### Docker image +=== "Docker Image" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + They are available from the following repositories: + + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-gc): -=== "GitHub Container Registry" - [ghcr.io GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-gc) ```bash docker pull ghcr.io/projectnessie/nessie-gc:::NESSIE_VERSION:: docker run ghcr.io/projectnessie/nessie-gc:::NESSIE_VERSION:: --help ``` -=== "Quay.io" - [quay.io Quay](https://quay.io/repository/projectnessie/nessie-gc?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie-gc?tab=tags): + ```bash docker pull quay.io/projectnessie/nessie-gc:::NESSIE_VERSION:: docker run quay.io/projectnessie/nessie-gc:::NESSIE_VERSION:: --help ``` -### Standalone uber jar +=== "Standalone Jar" + + Requires Java 11, Java 17 recommended. + + ```bash + curl -L -o nessie-gc-::NESSIE_VERSION::.jar \ + https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-gc-::NESSIE_VERSION::.jar + java -jar nessie-gc-::NESSIE_VERSION::.jar + ``` + +=== "Maven Central" + + * [Nessie GC on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie-integrations/nessie-gc-tool/::NESSIE_VERSION::/jar) + + * Gradle Kotlin snippet: + + ```kotlin + implementation("org.projectnessie.nessie-integrations:nessie-gc-tool:::NESSIE_VERSION::") + ``` + + * Maven snippet: -Requires Java 11, Java 17 recommended. + ```xml + + org.projectnessie.nessie-integrations + nessie-gc-tool + ::NESSIE_VERSION:: + + ``` + + * Download all dependencies with Maven: -```bash -curl -L -o nessie-gc-::NESSIE_VERSION::.jar \ - https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-gc-::NESSIE_VERSION::.jar -java -jar nessie-gc-::NESSIE_VERSION::.jar -``` + ```bash + mvn dependency:get -Dartifact=org.projectnessie.nessie-integrations:nessie-gc-tool:::NESSIE_VERSION:::jar + ``` ## Nessie Server Admin Tool Nessie's [Server Admin Tool](export_import.md) allows migration (export/import) of a Nessie repository. -### Docker image +=== "Docker Image" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + They are available from the following repositories: + + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin) -=== "GitHub Container Registry" - [ghcr.io GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin) ```bash docker pull ghcr.io/projectnessie/nessie-server-admin:::NESSIE_VERSION:: docker run ghcr.io/projectnessie/nessie-server-admin:::NESSIE_VERSION:: --help ``` -=== "Quay.io" - [quay.io Quay](https://quay.io/repository/projectnessie/nessie-server-admin?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie-server-admin?tab=tags) + ```bash docker pull quay.io/projectnessie/nessie-server-admin:::NESSIE_VERSION:: docker run quay.io/projectnessie/nessie-server-admin:::NESSIE_VERSION:: --help ``` -### Standalone uber jar +=== "Standalone Jar" + + Requires Java 17 or newer. + + ```bash + curl -L -o nessie-server-admin-tool-::NESSIE_VERSION::-runner.jar \ + https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-server-admin-tool-::NESSIE_VERSION::-runner.jar + java -jar nessie-server-admin-tool-::NESSIE_VERSION::-runner.jar + ``` + +=== "Maven Central" + + * [Nessie Server Admin Tool on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-server-admin-tool/::NESSIE_VERSION::/runner) + + * Gradle Kotlin snippet: + + ```kotlin + implementation("org.projectnessie.nessie:nessie-server-admin-tool:::NESSIE_VERSION:::runner") + ``` + + * Maven snippet: + + ```xml + + org.projectnessie.nessie + nessie-server-admin-tool + ::NESSIE_VERSION:: + + ``` -Requires Java 17 or newer. + * Download all dependencies with Maven: -```bash -curl -L -o nessie-server-admin-tool-::NESSIE_VERSION::-runner.jar \ - https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-server-admin-tool-::NESSIE_VERSION::-runner.jar -java -jar nessie-server-admin-tool-::NESSIE_VERSION::-runner.jar -``` + ```bash + mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-server-admin-tool:::NESSIE_VERSION:::jar + ``` ## Nessie REST API @@ -160,7 +279,19 @@ java -jar nessie-server-admin-tool-::NESSIE_VERSION::-runner.jar ## Nessie artifacts on Maven Central -[Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie) +Artifacts are available in two groups: `org.projectnessie.nessie` and +`org.projectnessie.nessie-integrations`. Most users will only need the `org.projectnessie.nessie` +group, which contains the Nessie server and CLI. The `org.projectnessie.nessie-integrations` group +contains additional tools and integrations: + +* Spark extensions +* Nessie GC tool + +Useful links: + +* [Nessie ::NESSIE_VERSION:: BOM (Bill of Materials)](https://search.maven.org/artifact/org.projectnessie.nessie/nessie/::NESSIE_VERSION::/pom) +* [Nessie ::NESSIE_VERSION:: `org.projectnessie.nessie` artifacts](https://search.maven.org/search?q=g:org.projectnessie.nessie%20v:::NESSIE_VERSION::) +* [Nessie ::NESSIE_VERSION:: `org.projectnessie.nessie-integrations` artifacts](https://search.maven.org/search?q=g:org.projectnessie.nessie-integrations%20v:::NESSIE_VERSION::) ## License Reports diff --git a/site/in-dev/index.md b/site/in-dev/index.md index 0bf537b0096..643f4a6dfed 100644 --- a/site/in-dev/index.md +++ b/site/in-dev/index.md @@ -14,20 +14,23 @@ builds. The state of the software as well as the documentation The main Nessie server serves the Nessie repository using the Iceberg REST API and Nessie's native REST API. -### Docker image +=== "Docker Image" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + + **The image tags are updated twice per day during weekdays.** -**The image tags are updated twice per day during weekdays.** + Images are available from the following repositories: + + * [GitHub Container Registry](https://ghcr.io/projectnessie/nessie-unstable): -=== "GitHub Container Registry" - [GitHub Container Registry](https://ghcr.io/projectnessie/nessie-unstable) ```bash docker pull ghcr.io/projectnessie/nessie-unstable docker run -p 19120:19120 -p 9000:9000 ghcr.io/projectnessie/nessie-unstable ``` -=== "Quay.io" - [quay.io](https://quay.io/repository/projectnessie/nessie-unstable?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie-unstable?tab=tags): + ```bash docker pull quay.io/projectnessie/nessie-unstable docker run -p 19120:19120 -p 9000:9000 quay.io/projectnessie/nessie-unstable @@ -59,20 +62,23 @@ Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. [Nessie GC](/nessie-nightly/gc/) allows mark and sweep data files based on flexible expiration policies. -### Docker image +=== "Docker Image" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + + **The image tags are updated twice per day during weekdays.** + + Images are available from the following repositories: -**The image tags are updated twice per day during weekdays.** + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-gc-unstable): -=== "GitHub Container Registry" - [GitHub Container Registry](https://ghcr.io/projectnessie/nessie-gc-unstable) ```bash docker pull ghcr.io/projectnessie/nessie-gc-unstable docker run ghcr.io/projectnessie/nessie-gc-unstable --help ``` -=== "Quay.io" - [quay.io](https://quay.io/repository/projectnessie/nessie-gc-unstable?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie-gc-unstable?tab=tags): + ```bash docker pull quay.io/projectnessie/nessie-gc-unstable docker run quay.io/projectnessie/nessie-gc-unstable --help @@ -83,20 +89,23 @@ Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. Nessie's [Server Admin Tool](/nessie-nightly/export-import/) allows migration (export/import) of a Nessie repository. -### Docker image +=== "Docker Image" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. -**The image tags are updated twice per day during weekdays.** + **The image tags are updated twice per day during weekdays.** + + They are available from the following repositories: + + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin-unstable) -=== "GitHub Container Registry" - [GitHub Container Registry](https://ghcr.io/projectnessie/nessie-server-admin-unstable) ```bash docker pull ghcr.io/projectnessie/nessie-server-admin-unstable docker run ghcr.io/projectnessie/nessie-server-admin-unstable --help ``` -=== "Quay.io" - [quay.io](https://quay.io/repository/projectnessie/nessie-server-admin-unstable?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie-server-admin-unstable?tab=tags) + ```bash docker pull quay.io/projectnessie/nessie-server-admin-unstable docker run quay.io/projectnessie/nessie-server-admin-unstable --help @@ -109,9 +118,10 @@ See [projectnessie/nessie GitHub](https://github.com/projectnessie/nessie) for b ## Nessie SNAPSHOT Maven artifacts Snapshot artifacts are available from Sonatype. The version of the published _SNAPSHOT_ artifacts -changes with every Nessie release. The currently published _SHAPSHOT_ version can be [inspected -in a browser on GitHub](https://github.com/projectnessie/nessie/blob/main/version.txt) or on the -command line using the following command: +changes with every Nessie release. The currently published _SNAPSHOT_ version can be [inspected in a +browser on GitHub](https://github.com/projectnessie/nessie/blob/main/version.txt) or on the command +line using the following command: + ```bash curl https://github.com/projectnessie/nessie/blob/main/version.txt ``` From b8569a26e960bcd5fed52b728a2e5fa5f0b2fe34 Mon Sep 17 00:00:00 2001 From: Alexandre Dutra Date: Thu, 27 Jun 2024 19:32:56 +0200 Subject: [PATCH 2/9] css tweak --- site/docs/stylesheets/extra.css | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/site/docs/stylesheets/extra.css b/site/docs/stylesheets/extra.css index 96efaee31f7..260dd07c839 100644 --- a/site/docs/stylesheets/extra.css +++ b/site/docs/stylesheets/extra.css @@ -21,3 +21,31 @@ img.bordered { .md-typeset td code { word-break: revert; } + +.md-typeset .tabbed-labels>label { + background-color: #efefef; + margin-right: 2px; +} + +.md-typeset .tabbed-set>input:first-child:checked~.tabbed-labels>:first-child, +.md-typeset .tabbed-set>input:nth-child(2):checked~.tabbed-labels>:nth-child(2), +.md-typeset .tabbed-set>input:nth-child(3):checked~.tabbed-labels>:nth-child(3), +.md-typeset .tabbed-set>input:nth-child(4):checked~.tabbed-labels>:nth-child(4), +.md-typeset .tabbed-set>input:nth-child(5):checked~.tabbed-labels>:nth-child(5), +.md-typeset .tabbed-set>input:nth-child(6):checked~.tabbed-labels>:nth-child(6), +.md-typeset .tabbed-set>input:nth-child(7):checked~.tabbed-labels>:nth-child(7), +.md-typeset .tabbed-set>input:nth-child(8):checked~.tabbed-labels>:nth-child(8), +.md-typeset .tabbed-set>input:nth-child(9):checked~.tabbed-labels>:nth-child(9), +.md-typeset .tabbed-set>input:nth-child(10):checked~.tabbed-labels>:nth-child(10), +.md-typeset .tabbed-set>input:nth-child(11):checked~.tabbed-labels>:nth-child(11), +.md-typeset .tabbed-set>input:nth-child(12):checked~.tabbed-labels>:nth-child(12), +.md-typeset .tabbed-set>input:nth-child(13):checked~.tabbed-labels>:nth-child(13), +.md-typeset .tabbed-set>input:nth-child(14):checked~.tabbed-labels>:nth-child(14), +.md-typeset .tabbed-set>input:nth-child(15):checked~.tabbed-labels>:nth-child(15), +.md-typeset .tabbed-set>input:nth-child(16):checked~.tabbed-labels>:nth-child(16), +.md-typeset .tabbed-set>input:nth-child(17):checked~.tabbed-labels>:nth-child(17), +.md-typeset .tabbed-set>input:nth-child(18):checked~.tabbed-labels>:nth-child(18), +.md-typeset .tabbed-set>input:nth-child(19):checked~.tabbed-labels>:nth-child(19), +.md-typeset .tabbed-set>input:nth-child(20):checked~.tabbed-labels>:nth-child(20) { + background-color: lightblue; +} \ No newline at end of file From 5fb195e7904f9b0345b220cce97f9e8cca75fbbb Mon Sep 17 00:00:00 2001 From: Alexandre Dutra Date: Thu, 27 Jun 2024 19:33:16 +0200 Subject: [PATCH 3/9] review comments --- site/docs/downloads/index.md | 25 ++++++++++++++++++++++ site/in-dev/index-release.md | 25 ++++++++++++++++++++++ site/in-dev/index.md | 41 +++++++++++++++++++++++++++++++++--- 3 files changed, 88 insertions(+), 3 deletions(-) diff --git a/site/docs/downloads/index.md b/site/docs/downloads/index.md index 9b65ed305a8..e245d6ade62 100644 --- a/site/docs/downloads/index.md +++ b/site/docs/downloads/index.md @@ -293,6 +293,31 @@ Useful links: * [Nessie {{ versions.nessie }} `org.projectnessie.nessie` artifacts](https://search.maven.org/search?q=g:org.projectnessie.nessie%20v:{{ versions.nessie }}) * [Nessie {{ versions.nessie }} `org.projectnessie.nessie-integrations` artifacts](https://search.maven.org/search?q=g:org.projectnessie.nessie-integrations%20v:{{ versions.nessie }}) +The following examples show how to add the Nessie BOM to your build configuration: + +=== "Maven" + In your Maven `pom.xml` add the Nessie BOM as a dependency: + ```xml + + + + org.projectnessie + nessie-bom + {{ versions.nessie }} + pom + import + + + + ``` +=== "Gradle (Kotlin)" + In your Gradle project's `build.gradle.kts` add the Nessie BOM as an enforced platform: + ```kotlin + dependencies { + enforcedPlatform("org.projectnessie:nessie-bom:{{ versions.nessie }}") + } + ``` + ## License Reports License reports for this release are [available via this link (zip file)](https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-aggregated-license-report-{{ versions.nessie }}.zip). diff --git a/site/in-dev/index-release.md b/site/in-dev/index-release.md index b5653897f72..0c36c903c21 100644 --- a/site/in-dev/index-release.md +++ b/site/in-dev/index-release.md @@ -293,6 +293,31 @@ Useful links: * [Nessie ::NESSIE_VERSION:: `org.projectnessie.nessie` artifacts](https://search.maven.org/search?q=g:org.projectnessie.nessie%20v:::NESSIE_VERSION::) * [Nessie ::NESSIE_VERSION:: `org.projectnessie.nessie-integrations` artifacts](https://search.maven.org/search?q=g:org.projectnessie.nessie-integrations%20v:::NESSIE_VERSION::) +The following examples show how to add the Nessie BOM to your build configuration: + +=== "Maven" + In your Maven `pom.xml` add the Nessie BOM as a dependency: + ```xml + + + + org.projectnessie + nessie-bom + ::NESSIE_VERSION:: + pom + import + + + + ``` +=== "Gradle (Kotlin)" + In your Gradle project's `build.gradle.kts` add the Nessie BOM as an enforced platform: + ```kotlin + dependencies { + enforcedPlatform("org.projectnessie:nessie-bom:::NESSIE_VERSION::") + } + ``` + ## License Reports License reports for this release are [available via this link (zip file)](https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-aggregated-license-report-::NESSIE_VERSION::.zip). diff --git a/site/in-dev/index.md b/site/in-dev/index.md index 643f4a6dfed..fdf05b484c6 100644 --- a/site/in-dev/index.md +++ b/site/in-dev/index.md @@ -118,14 +118,23 @@ See [projectnessie/nessie GitHub](https://github.com/projectnessie/nessie) for b ## Nessie SNAPSHOT Maven artifacts Snapshot artifacts are available from Sonatype. The version of the published _SNAPSHOT_ artifacts -changes with every Nessie release. The currently published _SNAPSHOT_ version can be [inspected in a -browser on GitHub](https://github.com/projectnessie/nessie/blob/main/version.txt) or on the command -line using the following command: +changes with every Nessie release. + +!!! note + Snapshot artifacts are meant for development and testing purposes only, especially when + developing against Nessie. They are not meant for production use. + +The currently published _SNAPSHOT_ version can be [inspected in a browser on +GitHub](https://github.com/projectnessie/nessie/blob/main/version.txt) or on the command line using +the following command: ```bash curl https://github.com/projectnessie/nessie/blob/main/version.txt ``` +Snapshot repositories must be added to your build configuration. The following examples show how to +add the repository to your build configuration: + === "Maven" In your Maven `pom.xml` add the SonaType repository: ```xml @@ -162,3 +171,29 @@ curl https://github.com/projectnessie/nessie/blob/main/version.txt } } ``` + +The following examples show how to add the Nessie BOM to your build configuration: + +=== "Maven" + In your Maven `pom.xml` add the Nessie BOM as a dependency: + ```xml + + + + org.projectnessie + nessie-bom + ::NESSIE_VERSION:: + pom + import + + + + ``` +=== "Gradle (Kotlin)" + In your Gradle project's `build.gradle.kts` add the Nessie BOM as an enforced platform: + ```kotlin + dependencies { + enforcedPlatform("org.projectnessie:nessie-bom:::NESSIE_VERSION::") + } + ``` + From a88c0b9d3a9d9699478b3435f74fed96e9b0c743 Mon Sep 17 00:00:00 2001 From: Alexandre Dutra Date: Thu, 27 Jun 2024 19:36:54 +0200 Subject: [PATCH 4/9] remove Maven Central tabs --- site/docs/downloads/index.md | 116 ++--------------------------------- site/in-dev/index-release.md | 116 ++--------------------------------- 2 files changed, 12 insertions(+), 220 deletions(-) diff --git a/site/docs/downloads/index.md b/site/docs/downloads/index.md index e245d6ade62..88164b78a04 100644 --- a/site/docs/downloads/index.md +++ b/site/docs/downloads/index.md @@ -66,46 +66,10 @@ The main Nessie server serves the Nessie repository using the Iceberg REST API a java -jar nessie-quarkus-{{ versions.nessie }}-runner.jar ``` -=== "Maven Central" - - * [Nessie Server on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-quarkus/{{ versions.nessie }}/runner) - - * Gradle Kotlin snippet: - - ```kotlin - implementation("org.projectnessie.nessie:nessie-quarkus:{{ versions.nessie }}:runner") - ``` - - * Maven snippet: - - ```xml - - org.projectnessie.nessie - nessie-quarkus - {{ versions.nessie }} - - ``` - - * Download all dependencies with Maven: - - ```bash - mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-quarkus:{{ versions.nessie }}:jar:runner - ``` - ## Nessie CLI & REPL [Nessie CLI](/nessie-latest/cli/) is both a command-line interface but primarily a REPL. -=== "Standalone Jar" - - Requires Java 11 or newer. - - ```bash - curl -L -o nessie-cli-{{ versions.nessie }}.jar \ - https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-cli-{{ versions.nessie }}.jar - java -jar nessie-cli-{{ versions.nessie }}.jar - ``` - === "Docker Image" Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. @@ -125,30 +89,14 @@ The main Nessie server serves the Nessie repository using the Iceberg REST API a docker run -it quay.io/projectnessie/nessie-cli:{{ versions.nessie }} ``` -=== "Maven Central" - - * [Nessie CLI on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-cli/{{ versions.nessie }}/jar) - - * Gradle Kotlin snippet: - - ```kotlin - implementation("org.projectnessie.nessie:nessie-cli:{{ versions.nessie }}") - ``` - - * Maven snippet: - - ```xml - - org.projectnessie.nessie - nessie-cli - {{ versions.nessie }} - - ``` +=== "Standalone Jar" - * Download all dependencies with Maven: + Requires Java 11 or newer. - ```bash - mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-cli:{{ versions.nessie }}:jar + ```bash + curl -L -o nessie-cli-{{ versions.nessie }}.jar \ + https://github.com/projectnessie/nessie/releases/download/nessie-{{ versions.nessie }}/nessie-cli-{{ versions.nessie }}.jar + java -jar nessie-cli-{{ versions.nessie }}.jar ``` ## Nessie GC Tool @@ -184,32 +132,6 @@ The main Nessie server serves the Nessie repository using the Iceberg REST API a java -jar nessie-gc-{{ versions.nessie }}.jar ``` -=== "Maven Central" - - * [Nessie GC on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie-integrations/nessie-gc-tool/{{ versions.nessie }}/jar) - - * Gradle Kotlin snippet: - - ```kotlin - implementation("org.projectnessie.nessie-integrations:nessie-gc-tool:{{ versions.nessie }}") - ``` - - * Maven snippet: - - ```xml - - org.projectnessie.nessie-integrations - nessie-gc-tool - {{ versions.nessie }} - - ``` - - * Download all dependencies with Maven: - - ```bash - mvn dependency:get -Dartifact=org.projectnessie.nessie-integrations:nessie-gc-tool:{{ versions.nessie }}:jar - ``` - ## Nessie Server Admin Tool Nessie's [Server Admin Tool](/nessie-latest/export-import/) allows migration (export/import) of a @@ -244,32 +166,6 @@ Nessie repository. java -jar nessie-server-admin-tool-{{ versions.nessie }}-runner.jar ``` -=== "Maven Central" - - * [Nessie Server Admin Tool on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-server-admin-tool/{{ versions.nessie }}/runner) - - * Gradle Kotlin snippet: - - ```kotlin - implementation("org.projectnessie.nessie:nessie-server-admin-tool:{{ versions.nessie }}:runner") - ``` - - * Maven snippet: - - ```xml - - org.projectnessie.nessie - nessie-server-admin-tool - {{ versions.nessie }} - - ``` - - * Download all dependencies with Maven: - - ```bash - mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-server-admin-tool:{{ versions.nessie }}:jar - ``` - ## Nessie REST API === "View on Swagger Hub" diff --git a/site/in-dev/index-release.md b/site/in-dev/index-release.md index 0c36c903c21..3318267faa6 100644 --- a/site/in-dev/index-release.md +++ b/site/in-dev/index-release.md @@ -65,46 +65,10 @@ The main Nessie server serves the Nessie repository using the Iceberg REST API a java -jar nessie-quarkus-::NESSIE_VERSION::-runner.jar ``` -=== "Maven Central" - - * [Nessie Server on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-quarkus/::NESSIE_VERSION::/runner) - - * Gradle Kotlin snippet: - - ```kotlin - implementation("org.projectnessie.nessie:nessie-quarkus:::NESSIE_VERSION:::runner") - ``` - - * Maven snippet: - - ```xml - - org.projectnessie.nessie - nessie-quarkus - ::NESSIE_VERSION:: - - ``` - - * Download all dependencies with Maven: - - ```bash - mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-quarkus:::NESSIE_VERSION:::jar:runner - ``` - ## Nessie CLI & REPL [Nessie CLI](cli.md) is both a command-line interface but primarily a REPL. -=== "Standalone Jar" - - Requires Java 11 or newer. - - ```bash - curl -L -o nessie-cli-::NESSIE_VERSION::.jar \ - https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-cli-::NESSIE_VERSION::.jar - java -jar nessie-cli-::NESSIE_VERSION::.jar - ``` - === "Docker Image" Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. @@ -125,30 +89,14 @@ The main Nessie server serves the Nessie repository using the Iceberg REST API a docker run -it quay.io/projectnessie/nessie-cli:::NESSIE_VERSION:: ``` -=== "Maven Central" - - * [Nessie CLI on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-cli/::NESSIE_VERSION::/jar) - - * Gradle Kotlin snippet: - - ```kotlin - implementation("org.projectnessie.nessie:nessie-cli:::NESSIE_VERSION::") - ``` - - * Maven snippet: - - ```xml - - org.projectnessie.nessie - nessie-cli - ::NESSIE_VERSION:: - - ``` +=== "Standalone Jar" - * Download all dependencies with Maven: + Requires Java 11 or newer. - ```bash - mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-cli:::NESSIE_VERSION:::jar + ```bash + curl -L -o nessie-cli-::NESSIE_VERSION::.jar \ + https://github.com/projectnessie/nessie/releases/download/nessie-::NESSIE_VERSION::/nessie-cli-::NESSIE_VERSION::.jar + java -jar nessie-cli-::NESSIE_VERSION::.jar ``` ## Nessie GC Tool @@ -184,32 +132,6 @@ The main Nessie server serves the Nessie repository using the Iceberg REST API a java -jar nessie-gc-::NESSIE_VERSION::.jar ``` -=== "Maven Central" - - * [Nessie GC on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie-integrations/nessie-gc-tool/::NESSIE_VERSION::/jar) - - * Gradle Kotlin snippet: - - ```kotlin - implementation("org.projectnessie.nessie-integrations:nessie-gc-tool:::NESSIE_VERSION::") - ``` - - * Maven snippet: - - ```xml - - org.projectnessie.nessie-integrations - nessie-gc-tool - ::NESSIE_VERSION:: - - ``` - - * Download all dependencies with Maven: - - ```bash - mvn dependency:get -Dartifact=org.projectnessie.nessie-integrations:nessie-gc-tool:::NESSIE_VERSION:::jar - ``` - ## Nessie Server Admin Tool Nessie's [Server Admin Tool](export_import.md) allows migration (export/import) of a @@ -244,32 +166,6 @@ Nessie repository. java -jar nessie-server-admin-tool-::NESSIE_VERSION::-runner.jar ``` -=== "Maven Central" - - * [Nessie Server Admin Tool on Maven Central](https://search.maven.org/artifact/org.projectnessie.nessie/nessie-server-admin-tool/::NESSIE_VERSION::/runner) - - * Gradle Kotlin snippet: - - ```kotlin - implementation("org.projectnessie.nessie:nessie-server-admin-tool:::NESSIE_VERSION:::runner") - ``` - - * Maven snippet: - - ```xml - - org.projectnessie.nessie - nessie-server-admin-tool - ::NESSIE_VERSION:: - - ``` - - * Download all dependencies with Maven: - - ```bash - mvn dependency:get -Dartifact=org.projectnessie.nessie:nessie-server-admin-tool:::NESSIE_VERSION:::jar - ``` - ## Nessie REST API === "View on Swagger Hub" From 4b4f14459987183a9e95d69d3b0c282ffebcc1a8 Mon Sep 17 00:00:00 2001 From: Alexandre Dutra Date: Thu, 27 Jun 2024 19:38:38 +0200 Subject: [PATCH 5/9] capitalization --- site/docs/downloads/index.md | 4 ++-- site/in-dev/index-release.md | 4 ++-- site/in-dev/index.md | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/site/docs/downloads/index.md b/site/docs/downloads/index.md index 88164b78a04..97acc9133b4 100644 --- a/site/docs/downloads/index.md +++ b/site/docs/downloads/index.md @@ -142,14 +142,14 @@ Nessie repository. Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. They are available from the following repositories: - * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin) + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin); ```bash docker pull ghcr.io/projectnessie/nessie-server-admin:{{ versions.nessie }} docker run ghcr.io/projectnessie/nessie-server-admin:{{ versions.nessie }} --help ``` - * [Quay.io](https://quay.io/repository/projectnessie/nessie-server-admin?tab=tags) + * [Quay.io](https://quay.io/repository/projectnessie/nessie-server-admin?tab=tags); ```bash docker pull quay.io/projectnessie/nessie-server-admin:{{ versions.nessie }} diff --git a/site/in-dev/index-release.md b/site/in-dev/index-release.md index 3318267faa6..952c77325a7 100644 --- a/site/in-dev/index-release.md +++ b/site/in-dev/index-release.md @@ -142,14 +142,14 @@ Nessie repository. Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. They are available from the following repositories: - * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin) + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin): ```bash docker pull ghcr.io/projectnessie/nessie-server-admin:::NESSIE_VERSION:: docker run ghcr.io/projectnessie/nessie-server-admin:::NESSIE_VERSION:: --help ``` - * [Quay.io](https://quay.io/repository/projectnessie/nessie-server-admin?tab=tags) + * [Quay.io](https://quay.io/repository/projectnessie/nessie-server-admin?tab=tags): ```bash docker pull quay.io/projectnessie/nessie-server-admin:::NESSIE_VERSION:: diff --git a/site/in-dev/index.md b/site/in-dev/index.md index fdf05b484c6..62890d25c67 100644 --- a/site/in-dev/index.md +++ b/site/in-dev/index.md @@ -97,14 +97,14 @@ Nessie repository. They are available from the following repositories: - * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin-unstable) + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-server-admin-unstable): ```bash docker pull ghcr.io/projectnessie/nessie-server-admin-unstable docker run ghcr.io/projectnessie/nessie-server-admin-unstable --help ``` - * [Quay.io](https://quay.io/repository/projectnessie/nessie-server-admin-unstable?tab=tags) + * [Quay.io](https://quay.io/repository/projectnessie/nessie-server-admin-unstable?tab=tags): ```bash docker pull quay.io/projectnessie/nessie-server-admin-unstable @@ -136,7 +136,7 @@ Snapshot repositories must be added to your build configuration. The following e add the repository to your build configuration: === "Maven" - In your Maven `pom.xml` add the SonaType repository: + In your Maven `pom.xml` add the Sonatype repository: ```xml From 494202b100087cf94b124eee0b1f56101c7945ac Mon Sep 17 00:00:00 2001 From: Alexandre Dutra Date: Fri, 28 Jun 2024 09:03:42 +0200 Subject: [PATCH 6/9] review comments --- site/docs/downloads/index.md | 20 ++++++++++++++-- site/docs/stylesheets/extra.css | 41 +++++++++++++++++---------------- site/in-dev/index-release.md | 20 ++++++++++++++-- 3 files changed, 57 insertions(+), 24 deletions(-) diff --git a/site/docs/downloads/index.md b/site/docs/downloads/index.md index 97acc9133b4..d56db3de503 100644 --- a/site/docs/downloads/index.md +++ b/site/docs/downloads/index.md @@ -197,7 +197,7 @@ The following examples show how to add the Nessie BOM to your build configuratio - org.projectnessie + org.projectnessie.nessie nessie-bom {{ versions.nessie }} pom @@ -206,11 +206,27 @@ The following examples show how to add the Nessie BOM to your build configuratio ``` + Then you can use all Nessie artifacts like this: + ```xml + + + org.projectnessie.nessie + nessie-client + + + ``` === "Gradle (Kotlin)" In your Gradle project's `build.gradle.kts` add the Nessie BOM as an enforced platform: ```kotlin dependencies { - enforcedPlatform("org.projectnessie:nessie-bom:{{ versions.nessie }}") + enforcedPlatform("org.projectnessie.nessie:nessie-bom:{{ versions.nessie }}") + } + ``` + A full example using the `nessie-client` artifact: + ```kotlin + dependencies { + enforcedPlatform("org.projectnessie.nessie:nessie-bom:{{ versions.nessie }}") + implementation("org.projectnessie.nessie:nessie-client") } ``` diff --git a/site/docs/stylesheets/extra.css b/site/docs/stylesheets/extra.css index 260dd07c839..f39c2a074f7 100644 --- a/site/docs/stylesheets/extra.css +++ b/site/docs/stylesheets/extra.css @@ -27,25 +27,26 @@ img.bordered { margin-right: 2px; } -.md-typeset .tabbed-set>input:first-child:checked~.tabbed-labels>:first-child, -.md-typeset .tabbed-set>input:nth-child(2):checked~.tabbed-labels>:nth-child(2), -.md-typeset .tabbed-set>input:nth-child(3):checked~.tabbed-labels>:nth-child(3), -.md-typeset .tabbed-set>input:nth-child(4):checked~.tabbed-labels>:nth-child(4), -.md-typeset .tabbed-set>input:nth-child(5):checked~.tabbed-labels>:nth-child(5), -.md-typeset .tabbed-set>input:nth-child(6):checked~.tabbed-labels>:nth-child(6), -.md-typeset .tabbed-set>input:nth-child(7):checked~.tabbed-labels>:nth-child(7), -.md-typeset .tabbed-set>input:nth-child(8):checked~.tabbed-labels>:nth-child(8), -.md-typeset .tabbed-set>input:nth-child(9):checked~.tabbed-labels>:nth-child(9), -.md-typeset .tabbed-set>input:nth-child(10):checked~.tabbed-labels>:nth-child(10), -.md-typeset .tabbed-set>input:nth-child(11):checked~.tabbed-labels>:nth-child(11), -.md-typeset .tabbed-set>input:nth-child(12):checked~.tabbed-labels>:nth-child(12), -.md-typeset .tabbed-set>input:nth-child(13):checked~.tabbed-labels>:nth-child(13), -.md-typeset .tabbed-set>input:nth-child(14):checked~.tabbed-labels>:nth-child(14), -.md-typeset .tabbed-set>input:nth-child(15):checked~.tabbed-labels>:nth-child(15), -.md-typeset .tabbed-set>input:nth-child(16):checked~.tabbed-labels>:nth-child(16), -.md-typeset .tabbed-set>input:nth-child(17):checked~.tabbed-labels>:nth-child(17), -.md-typeset .tabbed-set>input:nth-child(18):checked~.tabbed-labels>:nth-child(18), -.md-typeset .tabbed-set>input:nth-child(19):checked~.tabbed-labels>:nth-child(19), -.md-typeset .tabbed-set>input:nth-child(20):checked~.tabbed-labels>:nth-child(20) { +/* Highlights the current selected tab (matches the nth tab corresponding to the nth checked input). */ +.md-typeset .tabbed-set > input:first-child:checked ~ .tabbed-labels > :first-child, +.md-typeset .tabbed-set > input:nth-child(2):checked ~ .tabbed-labels > :nth-child(2), +.md-typeset .tabbed-set > input:nth-child(3):checked ~ .tabbed-labels > :nth-child(3), +.md-typeset .tabbed-set > input:nth-child(4):checked ~ .tabbed-labels > :nth-child(4), +.md-typeset .tabbed-set > input:nth-child(5):checked ~ .tabbed-labels > :nth-child(5), +.md-typeset .tabbed-set > input:nth-child(6):checked ~ .tabbed-labels > :nth-child(6), +.md-typeset .tabbed-set > input:nth-child(7):checked ~ .tabbed-labels > :nth-child(7), +.md-typeset .tabbed-set > input:nth-child(8):checked ~ .tabbed-labels > :nth-child(8), +.md-typeset .tabbed-set > input:nth-child(9):checked ~ .tabbed-labels > :nth-child(9), +.md-typeset .tabbed-set > input:nth-child(10):checked ~ .tabbed-labels > :nth-child(10), +.md-typeset .tabbed-set > input:nth-child(11):checked ~ .tabbed-labels > :nth-child(11), +.md-typeset .tabbed-set > input:nth-child(12):checked ~ .tabbed-labels > :nth-child(12), +.md-typeset .tabbed-set > input:nth-child(13):checked ~ .tabbed-labels > :nth-child(13), +.md-typeset .tabbed-set > input:nth-child(14):checked ~ .tabbed-labels > :nth-child(14), +.md-typeset .tabbed-set > input:nth-child(15):checked ~ .tabbed-labels > :nth-child(15), +.md-typeset .tabbed-set > input:nth-child(16):checked ~ .tabbed-labels > :nth-child(16), +.md-typeset .tabbed-set > input:nth-child(17):checked ~ .tabbed-labels > :nth-child(17), +.md-typeset .tabbed-set > input:nth-child(18):checked ~ .tabbed-labels > :nth-child(18), +.md-typeset .tabbed-set > input:nth-child(19):checked ~ .tabbed-labels > :nth-child(19), +.md-typeset .tabbed-set > input:nth-child(20):checked ~ .tabbed-labels > :nth-child(20) { background-color: lightblue; } \ No newline at end of file diff --git a/site/in-dev/index-release.md b/site/in-dev/index-release.md index 952c77325a7..9d2de720621 100644 --- a/site/in-dev/index-release.md +++ b/site/in-dev/index-release.md @@ -197,7 +197,7 @@ The following examples show how to add the Nessie BOM to your build configuratio - org.projectnessie + org.projectnessie.nessie nessie-bom ::NESSIE_VERSION:: pom @@ -206,11 +206,27 @@ The following examples show how to add the Nessie BOM to your build configuratio ``` + Then you can use all Nessie artifacts like this: + ```xml + + + org.projectnessie.nessie + nessie-client + + + ``` === "Gradle (Kotlin)" In your Gradle project's `build.gradle.kts` add the Nessie BOM as an enforced platform: ```kotlin dependencies { - enforcedPlatform("org.projectnessie:nessie-bom:::NESSIE_VERSION::") + enforcedPlatform("org.projectnessie.nessie:nessie-bom:::NESSIE_VERSION::") + } + ``` + A full example using the `nessie-client` artifact: + ```kotlin + dependencies { + enforcedPlatform("org.projectnessie.nessie:nessie-bom:::NESSIE_VERSION::") + implementation("org.projectnessie.nessie:nessie-client") } ``` From b36d876d12b3063a5e2939e1d294e19434454cab Mon Sep 17 00:00:00 2001 From: Alexandre Dutra Date: Fri, 28 Jun 2024 09:06:20 +0200 Subject: [PATCH 7/9] review comments --- site/docs/stylesheets/extra.css | 7 +++++++ site/in-dev/index.md | 20 ++++++++++++++++++-- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/site/docs/stylesheets/extra.css b/site/docs/stylesheets/extra.css index f39c2a074f7..9db979b8b88 100644 --- a/site/docs/stylesheets/extra.css +++ b/site/docs/stylesheets/extra.css @@ -22,6 +22,13 @@ img.bordered { word-break: revert; } +.md-typeset .tabbed-set>.tabbed-content { + padding: 0 .5em 0 .5em; + border: 1px solid #ababab; + border-bottom-left-radius: .3em; + border-bottom-right-radius: .3em; +} + .md-typeset .tabbed-labels>label { background-color: #efefef; margin-right: 2px; diff --git a/site/in-dev/index.md b/site/in-dev/index.md index 62890d25c67..c76a64f9fe4 100644 --- a/site/in-dev/index.md +++ b/site/in-dev/index.md @@ -180,7 +180,7 @@ The following examples show how to add the Nessie BOM to your build configuratio - org.projectnessie + org.projectnessie.nessie nessie-bom ::NESSIE_VERSION:: pom @@ -189,11 +189,27 @@ The following examples show how to add the Nessie BOM to your build configuratio ``` + Then you can use all Nessie artifacts like this: + ```xml + + + org.projectnessie.nessie + nessie-client + + + ``` === "Gradle (Kotlin)" In your Gradle project's `build.gradle.kts` add the Nessie BOM as an enforced platform: ```kotlin dependencies { - enforcedPlatform("org.projectnessie:nessie-bom:::NESSIE_VERSION::") + enforcedPlatform("org.projectnessie.nessie:nessie-bom:::NESSIE_VERSION::") + } + ``` + A full example using the `nessie-client` artifact: + ```kotlin + dependencies { + enforcedPlatform("org.projectnessie.nessie:nessie-bom:::NESSIE_VERSION::") + implementation("org.projectnessie.nessie:nessie-client") } ``` From dc2dfb349c929cb193c4e91fb680278aee5ab78f Mon Sep 17 00:00:00 2001 From: Alexandre Dutra Date: Fri, 28 Jun 2024 09:17:44 +0200 Subject: [PATCH 8/9] missing tab --- site/in-dev/index.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/site/in-dev/index.md b/site/in-dev/index.md index c76a64f9fe4..1b880b1912c 100644 --- a/site/in-dev/index.md +++ b/site/in-dev/index.md @@ -38,20 +38,23 @@ The main Nessie server serves the Nessie repository using the Iceberg REST API a ## Nessie CLI unstable/nightly -### Docker image +=== "Docker Image" -Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + Docker images are multiplatform images for amd64, arm64, ppc64le, s390x. + + **The image tags are updated twice per day during weekdays.** -**The image tags are updated twice per day during weekdays.** + Images are available from the following repositories: + + * [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-cli-unstable): -=== "GitHub Container Registry" - [GitHub Container Registry](https://github.com/projectnessie/nessie/pkgs/container/nessie-cli-unstable) ```bash docker pull ghcr.io/projectnessie/nessie-cli-unstable docker run -it ghcr.io/projectnessie/nessie-cli-unstable ``` -=== "Quay.io" - [quay.io](https://quay.io/repository/projectnessie/nessie-cli-unstable?tab=tags) + + * [Quay.io](https://quay.io/repository/projectnessie/nessie-cli-unstable?tab=tags): + ```bash docker pull quay.io/projectnessie/nessie-cli-unstable docker run -it quay.io/projectnessie/nessie-cli-unstable From 3b749432205e1d9fc32b572ebb43e8d194b5a592 Mon Sep 17 00:00:00 2001 From: Alexandre Dutra Date: Fri, 28 Jun 2024 09:26:17 +0200 Subject: [PATCH 9/9] round tabs --- site/docs/stylesheets/extra.css | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/site/docs/stylesheets/extra.css b/site/docs/stylesheets/extra.css index 9db979b8b88..045ef850c00 100644 --- a/site/docs/stylesheets/extra.css +++ b/site/docs/stylesheets/extra.css @@ -31,7 +31,10 @@ img.bordered { .md-typeset .tabbed-labels>label { background-color: #efefef; - margin-right: 2px; + border-top-left-radius: .3em; + border-top-right-radius: .3em; + margin-left: 1px; + margin-right: 1px; } /* Highlights the current selected tab (matches the nth tab corresponding to the nth checked input). */