align terminology -> dataset != version

[m1ci]

The terminology used by the client is not aligned with the databus terminology.

The client uses:

  --title TEXT        Dataset title  [required]
  --abstract TEXT     Dataset abstract max 200 chars  [required]
  --description TEXT  Dataset description  [required]

which is actually an artifact version.

[DhanashreePetare]

Greetings @m1ci . I am interested to work on this issue. Can you please assign me the same. Thankyou.

[Tahoora-Tabassum]

Thanks for pointing this out — I agree this is a terminology mismatch.

From my understanding, the current CLI options (--title, --abstract, --description) actually describe artifact/version metadata, not dataset-level metadata, which makes the naming confusing for users.

I see two possible ways to address this:

1. Non-breaking approach: keep the existing CLI arguments but, update the help text and documentation to clearly state that these fields belong to the artifact/version (e.g. “artifact version title/abstract/description”).

2. Breaking but cleaner approach: rename the CLI arguments to version-specific names to fully align with Databus terminology.

I’d prefer to start with option 1 to avoid breaking existing workflows, unless maintainers would rather go for the cleaner but breaking change.

Please let me know which approach you’d like — I’m happy to prepare a PR accordingly

[AggarwalKashvi]

Hi @m1ci, I’d like to work on this issue if it’s still open. I’m happy to take the non-breaking approach first and update the help text/docs as discussed. Please assign it to me if that works. Thanks!

[vaibhav45sktech]

Greetings @m1ci . Could u please review my pr I have updated the help text to clarify the Databus mappings (Artifact vs. Version) while keeping the original argument names to preserve compatibility. If you prefer I will rename the arguments entirely to strictly match the terminology, please let me know and I can switch to that approach.

[Integer-Ctrl]

@m1ci
@vaibhav45sktech

I took a closer look at the deploy option, and from my perspective the current deploy method is missing a significant amount of functionality compared to the Databus. In comparison, the Databus itself is much more flexible (see https://databus.dbpedia.org/app/publish-wizard).

To summarize the data model:

• A group has its own: title, abstract, description
• An artifact has its own: name, title, abstract, description
• A version has its own: name (= version, e.g. YYYY-MM-DD), title, abstract, description

Currently, the --title, --abstract, and --description parameters are applied to both the artifact and the version, which does not reflect this separation.

Given these limitations of the deploy command, I think it would be best either to:

• Limit the scope to something like “Artifact & Version Title” -> change descriptions/help texts/docstrings, or
• Dismiss this issue for now and revisit it later with a refactoring towards a more powerful deploy command (not planned currently)

[vaibhav45sktech]

@m1ci @vaibhav45sktech

I took a closer look at the deploy option, and from my perspective the current deploy method is missing a significant amount of functionality compared to the Databus. In comparison, the Databus itself is much more flexible (see https://databus.dbpedia.org/app/publish-wizard).

To summarize the data model:

• A group has its own: title, abstract, description
• An artifact has its own: name, title, abstract, description
• A version has its own: name (= version, e.g. YYYY-MM-DD), title, abstract, description

Currently, the --title, --abstract, and --description parameters are applied to both the artifact and the version, which does not reflect this separation.

Given these limitations of the deploy command, I think it would be best either to:

• Limit the scope to something like “Artifact & Version Title” -> change descriptions/help texts/docstrings, or
• Dismiss this issue for now and revisit it later with a refactoring towards a more powerful deploy command (not planned currently)

@Integer-Ctrl Thankyou for the review and feedback

[vaibhav45sktech]

@m1ci @vaibhav45sktech

I took a closer look at the deploy option, and from my perspective the current deploy method is missing a significant amount of functionality compared to the Databus. In comparison, the Databus itself is much more flexible (see https://databus.dbpedia.org/app/publish-wizard).

To summarize the data model:

• A group has its own: title, abstract, description
• An artifact has its own: name, title, abstract, description
• A version has its own: name (= version, e.g. YYYY-MM-DD), title, abstract, description

Currently, the --title, --abstract, and --description parameters are applied to both the artifact and the version, which does not reflect this separation.

Given these limitations of the deploy command, I think it would be best either to:

• Limit the scope to something like “Artifact & Version Title” -> change descriptions/help texts/docstrings, or
• Dismiss this issue for now and revisit it later with a refactoring towards a more powerful deploy command (not planned currently)

Greetings @Integer-Ctrl , I have done the suggested updates , could you please have a look at the pr #47