diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index aafb2d31f18827f47c531faae395539e913f46f1..22a56d79a6dce74c09b58877adb784758f0db1ba 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 53a212a2115ae0463d063470658af4131fba8311..05a698fe98efcbe9e9dff506972aec1edbd2b5d4 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 908dc3a65642ded43094169730fa4e915723c662..d7244e2b05e519c62fe0629279490f8205c75c10 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 24441b95d4f361eb0e45c41c486139b43d362945..55fdf639bbafc00991b6f6a5b36916c06c0faa83 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 7551711f07d65173a49c9d48f3d808e6da9c34e3..b8c78b5c3f325e3fc040e856a861c96a3e4e979f 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",