From ed41e0e2764d9007228e153cd28ea36873afaf95 Mon Sep 17 00:00:00 2001 From: Dan Allen Date: Tue, 29 Oct 2024 17:30:35 -0600 Subject: [PATCH] resolves #45 rename project to Antora Collector and project repository to antora-collector --- CHANGELOG.adoc | 1 + docs/{ => collector-extension}/antora.yml | 4 ++-- docs/{ => collector-extension}/modules/ROOT/nav.adoc | 0 .../modules/ROOT/pages/concepts.adoc | 0 .../modules/ROOT/pages/configure-clean.adoc | 0 .../modules/ROOT/pages/configure-run.adoc | 0 .../modules/ROOT/pages/configure-scan.adoc | 0 .../modules/ROOT/pages/configure-worktree.adoc | 0 .../modules/ROOT/pages/configure.adoc | 0 .../{ => collector-extension}/modules/ROOT/pages/index.adoc | 2 +- .../modules/ROOT/pages/install.adoc | 0 .../modules/ROOT/pages/register.adoc | 0 .../modules/ROOT/pages/use-cases.adoc | 0 package.json | 2 +- packages/collector-extension/package.json | 6 +++--- 15 files changed, 8 insertions(+), 7 deletions(-) rename docs/{ => collector-extension}/antora.yml (77%) rename docs/{ => collector-extension}/modules/ROOT/nav.adoc (100%) rename docs/{ => collector-extension}/modules/ROOT/pages/concepts.adoc (100%) rename docs/{ => collector-extension}/modules/ROOT/pages/configure-clean.adoc (100%) rename docs/{ => collector-extension}/modules/ROOT/pages/configure-run.adoc (100%) rename docs/{ => collector-extension}/modules/ROOT/pages/configure-scan.adoc (100%) rename docs/{ => collector-extension}/modules/ROOT/pages/configure-worktree.adoc (100%) rename docs/{ => collector-extension}/modules/ROOT/pages/configure.adoc (100%) rename docs/{ => collector-extension}/modules/ROOT/pages/index.adoc (96%) rename docs/{ => collector-extension}/modules/ROOT/pages/install.adoc (100%) rename docs/{ => collector-extension}/modules/ROOT/pages/register.adoc (100%) rename docs/{ => collector-extension}/modules/ROOT/pages/use-cases.adoc (100%) diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index aafb2d3..22a56d7 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -15,6 +15,7 @@ For a detailed view of what's changed, refer to the {url-repo}/commits[commit hi * only report the base call instead of the whole command when the command cannot be found * move repository URL inside paranthetical context in error message * report missing command in error message using ps.spawnargs[0] instead of cmdv[0] for consistency +* rename project to Antora Collector and project repository to antora-collector (name of npm package remains the same) (#45) === Fixed diff --git a/docs/antora.yml b/docs/collector-extension/antora.yml similarity index 77% rename from docs/antora.yml rename to docs/collector-extension/antora.yml index 53a212a..05a698f 100644 --- a/docs/antora.yml +++ b/docs/collector-extension/antora.yml @@ -1,5 +1,5 @@ name: collector-extension -title: Antora Collector Extension +title: Antora Collector version: '1.0' prerelease: '.0-beta.3' asciidoc: @@ -10,7 +10,7 @@ asciidoc: release-version: '1.0.0-beta.3' release-dist-tag: latest release-date: '2024-10-10' - url-repo: https://gitlab.com/antora/antora-collector-extension + url-repo: https://gitlab.com/antora/antora-collector url-chat: https://chat.antora.org nav: - modules/ROOT/nav.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/collector-extension/modules/ROOT/nav.adoc similarity index 100% rename from docs/modules/ROOT/nav.adoc rename to docs/collector-extension/modules/ROOT/nav.adoc diff --git a/docs/modules/ROOT/pages/concepts.adoc b/docs/collector-extension/modules/ROOT/pages/concepts.adoc similarity index 100% rename from docs/modules/ROOT/pages/concepts.adoc rename to docs/collector-extension/modules/ROOT/pages/concepts.adoc diff --git a/docs/modules/ROOT/pages/configure-clean.adoc b/docs/collector-extension/modules/ROOT/pages/configure-clean.adoc similarity index 100% rename from docs/modules/ROOT/pages/configure-clean.adoc rename to docs/collector-extension/modules/ROOT/pages/configure-clean.adoc diff --git a/docs/modules/ROOT/pages/configure-run.adoc b/docs/collector-extension/modules/ROOT/pages/configure-run.adoc similarity index 100% rename from docs/modules/ROOT/pages/configure-run.adoc rename to docs/collector-extension/modules/ROOT/pages/configure-run.adoc diff --git a/docs/modules/ROOT/pages/configure-scan.adoc b/docs/collector-extension/modules/ROOT/pages/configure-scan.adoc similarity index 100% rename from docs/modules/ROOT/pages/configure-scan.adoc rename to docs/collector-extension/modules/ROOT/pages/configure-scan.adoc diff --git a/docs/modules/ROOT/pages/configure-worktree.adoc b/docs/collector-extension/modules/ROOT/pages/configure-worktree.adoc similarity index 100% rename from docs/modules/ROOT/pages/configure-worktree.adoc rename to docs/collector-extension/modules/ROOT/pages/configure-worktree.adoc diff --git a/docs/modules/ROOT/pages/configure.adoc b/docs/collector-extension/modules/ROOT/pages/configure.adoc similarity index 100% rename from docs/modules/ROOT/pages/configure.adoc rename to docs/collector-extension/modules/ROOT/pages/configure.adoc diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/collector-extension/modules/ROOT/pages/index.adoc similarity index 96% rename from docs/modules/ROOT/pages/index.adoc rename to docs/collector-extension/modules/ROOT/pages/index.adoc index 908dc3a..d7244e2 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/collector-extension/modules/ROOT/pages/index.adoc @@ -7,7 +7,7 @@ You're encouraged to test it and give feedback, but take caution when using it i == Overview -The Antora Collector extension enables you to generate files and import them into the content aggregate. +Antora Collector provides an extension that enables you to generate files and import them into the content aggregate. The purpose of this extension is to contribute additional files to content source roots to supplement the files discovered from the conventional content source roots Antora has already loaded. This activity happens per content source root by a Collector instance. diff --git a/docs/modules/ROOT/pages/install.adoc b/docs/collector-extension/modules/ROOT/pages/install.adoc similarity index 100% rename from docs/modules/ROOT/pages/install.adoc rename to docs/collector-extension/modules/ROOT/pages/install.adoc diff --git a/docs/modules/ROOT/pages/register.adoc b/docs/collector-extension/modules/ROOT/pages/register.adoc similarity index 100% rename from docs/modules/ROOT/pages/register.adoc rename to docs/collector-extension/modules/ROOT/pages/register.adoc diff --git a/docs/modules/ROOT/pages/use-cases.adoc b/docs/collector-extension/modules/ROOT/pages/use-cases.adoc similarity index 100% rename from docs/modules/ROOT/pages/use-cases.adoc rename to docs/collector-extension/modules/ROOT/pages/use-cases.adoc diff --git a/package.json b/package.json index 24441b9..55fdf63 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "private": true, - "name": "antora-collector-extension", + "name": "antora-collector", "version": "1.0.0-beta.3", "workspaces": [ "packages/*" diff --git a/packages/collector-extension/package.json b/packages/collector-extension/package.json index 7551711..b8c78b5 100644 --- a/packages/collector-extension/package.json +++ b/packages/collector-extension/package.json @@ -1,7 +1,7 @@ { "name": "@antora/collector-extension", "version": "1.0.0-beta.3", - "description": "An Antora extension that runs a configurable command per content root and collects the content files that it generates.", + "description": "An Antora extension that runs the specified commands per content root and imports the specified files into the content aggregate.", "license": "MPL-2.0", "author": "OpenDevise Inc. (https://opendevise.com)", "contributors": [ @@ -9,9 +9,9 @@ "Sarah White " ], "homepage": "https://antora.org", - "repository": "gitlab:antora/antora-collector-extension", + "repository": "gitlab:antora/antora-collector", "bugs": { - "url": "https://gitlab.com/antora/antora-collector-extension/issues" + "url": "https://gitlab.com/antora/antora-collector/issues" }, "scripts": { "postpublish": "npx -y downdoc --postpublish", -- GitLab