argoproj / argo-cd

Declarative Continuous Deployment for Kubernetes
https://argo-cd.readthedocs.io
Apache License 2.0
18.06k stars 5.52k forks source link

Document iconClass and displayName fields for custom resource action discovery #20460

Open crenshaw-dev opened 1 month ago

crenshaw-dev commented 1 month ago

Summary

Document the iconClass and displayName fields which can be set via custom resource action discovery scripts.

local actions = {}
actions["create-job"] = {
  ["iconClass"] = "fa fa-fw fa-play",
  ["displayName"] = "Create Job"
}
return actions

Motivation

It's currently a hidden feature.

Proposal

Add info to the custom resource actions docs page.

sikehish commented 1 month ago

Can I be assigned this issue?

surajyadav1108 commented 1 month ago

Can I be assigned this issue?

you don't need to be assigned for good first issues go ahead 👍

jaehanbyun commented 1 month ago

@sikehish, Are you currently working on it? If not, i would like solve it!

sikehish commented 1 month ago

@sikehish, Are you currently working on it? If not, i would like solve it!

Im working on it, will let you know if I'm not able to :)

sikehish commented 1 month ago

HI @crenshaw-dev @surajyadav1108 . Just wanted to clarify a few things. I believe I need to make changes in docs/operator-manual/resource_actions.md in this case. Is that right? Also, Do I need to create a new section for this under Custom Resource Actions? I dont see any existing subsection that covers the various fields that can be set via custom resource action discovery scripts. Also let me know if there's a structure that you want me to follow(a table, for instance).