Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EPIC: Rework naming convention for string constants, that are used to configure ocm-cli #286

Open
hilmarf opened this issue Oct 18, 2024 · 2 comments
Open

EPIC: Rework naming convention for string constants, that are used to configure ocm-cli #286

hilmarf opened this issue Oct 18, 2024 · 2 comments
Labels
area/ipcei kind/enhancement Enhancement, improvement, extension kind/epic Large multi-story topic
Milestone
2024-Q4

Comments

@hilmarf
Copy link
Member

hilmarf commented Oct 18, 2024 •
edited
Loading

What would you like to be added:

As an end user it would make my life easier, when I would understand the naming convention, which is used to name:

  • uploadhandlers
  • downloadhandlers
  • input types - @mandelsoft is there a way to list all available input types?
  • attribute keys

Why is this needed:

The historical grown mixture of names, which we do have right now, is hard to explain to end users. Especially when dealing with the same kind of blob, downloadhandler and uploadhandler should use the same name or artifactType or mimetype.
@hilmarf hilmarf added the kind/enhancement Enhancement, improvement, extension label Oct 18, 2024
@hilmarf hilmarf added this to the 2024-Q4 milestone Oct 18, 2024
@hilmarf hilmarf added the kind/epic Large multi-story topic label Oct 18, 2024
@frewilhelm
Copy link

I am supporting the idea using the builtin-prefix to show that one can replace a builtin downloader, ..., with a custom one.

hilmarf added a commit to open-component-model/ocm that referenced this issue Oct 21, 2024
@hilmarf
just fix uploader documentation
b075a14 
NOTHING more!

renaming might happen with implementation of:
open-component-model/ocm-project#286
@hilmarf hilmarf mentioned this issue Oct 21, 2024
Merged
hilmarf added a commit to open-component-model/ocm that referenced this issue Oct 21, 2024
@hilmarf
just fix uploader documentation (#991)
014afa2 
Just doing the documentation fix, without any renaning. NOTHING more!

This is now a replacement of:
#944

renaming might happen with implementation of:
open-component-model/ocm-project#286
@hilmarf
Copy link
Member Author

hilmarf commented Oct 21, 2024

I am supporting the idea using the builtin-prefix to show that one can replace a builtin downloader, ..., with a custom one.

like this: https://github.com/open-component-model/internal-processes/pull/14/commits/a69e1b45fd9de482cba7d5b7e56a752c646ba40b ?

@morri-son morri-son changed the title check and maybe rename string constants, that are used to configure ocm-cli Rework naming convention for string constants, that are used to configure ocm-cli Oct 22, 2024
@morri-son morri-son changed the title Rework naming convention for string constants, that are used to configure ocm-cli EPIC: Rework naming convention for string constants, that are used to configure ocm-cli Oct 22, 2024
Skarlso pushed a commit to open-component-model/ocm that referenced this issue Oct 22, 2024
@hilmarf @Skarlso
just fix uploader documentation (#991)
76b86b6 
Just doing the documentation fix, without any renaning. NOTHING more!

This is now a replacement of:
#944

renaming might happen with implementation of:
open-component-model/ocm-project#286
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/ipcei kind/enhancement Enhancement, improvement, extension kind/epic Large multi-story topic
Projects
OCM Backlog Board
Status: 🆕 ToDo
Milestone
2024-Q4
Development

No branches or pull requests
2 participants
@hilmarf @frewilhelm