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.

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

Add description to groups #428

Open
pehala opened this issue Aug 8, 2024 · 3 comments
Open

Add description to groups #428

pehala opened this issue Aug 8, 2024 · 3 comments
Assignees
Labels
enhancement New feature or request sct

Comments

@pehala
Copy link

pehala commented Aug 8, 2024

Currently, there is a lot of groups, but it hard to know what each of the groups should be doing. I think we need some transparency over that. For example, there are longevity tests that run only 12H but you cannot read that information anywhere

My proposal is to add a description to each group, where we could define a description so that everyone that is not that familiar with SCT could understand why this group exists and what are the specifics.

@pehala pehala added enhancement New feature or request sct labels Aug 8, 2024
@fruch
Copy link
Contributor

fruch commented Aug 15, 2024

My suggestion is as follows:

  1. we'll add file with description in each folder in SCT
  2. SCT would be change to apply this description into jenkins job description
  3. Argus would read those during scan of jobs, and save it
  4. Argus would should those a tooltips

bonus:

  • argus to have a way to edit those - (but not sure it would be wise, since it would eventually get out of sync with the source in SCT)

@pehala
Copy link
Author

pehala commented Aug 15, 2024

we'll add file with description in each folder in SCT

Could we create one file for Argus all metadata (e.g. name, description) instead? I am not sure that adding yet another file that contains only one piece of information is a good idea.
Also it would be easier to have one file so that we could easily add additional metadata in the future, just by adding more fields to existing file

@fruch
Copy link
Contributor

fruch commented Aug 15, 2024

we'll add file with description in each folder in SCT

Could we create one file for Argus all metadata (e.g. name, description) instead? I am not sure that adding yet another file that contains only one piece of information is a good idea. Also it would be easier to have one file so that we could easily add additional metadata in the future, just by adding more fields to existing file

that file won't reach argus directly, i.e. it would be used to update the job.

one file is better yes, but now it's need to have a format, and it might complex backporting a bit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request sct
Projects
None yet
Development

No branches or pull requests

3 participants