argoproj / argo-cd

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

ArgoCD docs for resource lifecycle hook should include icon #7488

Open jsoref opened 3 years ago

jsoref commented 3 years ago

If you are trying to resolve an environment-specific issue or have a one-off question about the edge case that does not require a feature then please consider asking a question in argocd slack channel.

Checklist:

Describe the bug

The icon ⚓ appears on objects and they can vanish relatively quickly leaving one to wonder "what was that?"

With a lot of effort, we found a page that talks about a thing that "probably was that": https://argo-cd.readthedocs.io/en/stable/user-guide/resource_hooks/

But, there's no screen capture of an example to confirm "yep, it was that!"

To Reproduce

  1. Install a new helm chart containing ingress-nginx
  2. Visit argocd for the app and watch things come/go and wonder what the ⚓ means -- and frustratingly have it run away before one can hover to figure it out
  3. Visit https://argo-cd.readthedocs.io/en/stable/user-guide/ and in the 🔍 box, enter anchor, or icons, get no results
  4. Using way too many steps, search github for anchor and then google for resource hooks to find the page https://argo-cd.readthedocs.io/en/stable/user-guide/resource_hooks/ which still doesn't confirm this is what we saw.

Expected behavior

  1. The documentation should contain an example of the object as it would appear in argocd.
  2. The documentation and app should have an icons key section to help people understand what icons mean.

Screenshots

image image

Version

{
    "Version": "v2.1.0+50b0010",
    "BuildDate": "2021-08-04T00:28:17Z",
    "GitCommit": "50b00104704f28780b320ae043ecbda64214f132",
    "GitTreeState": "clean",
    "GoVersion": "go1.16.5",
    "Compiler": "gc",
    "Platform": "linux/amd64",
    "KsonnetVersion": "v0.13.1",
    "KustomizeVersion": "v4.2.0 2021-06-30T22:49:26Z",
    "HelmVersion": "v3.6.0+g7f2df64",
    "KubectlVersion": "v0.21.0",
    "JsonnetVersion": "v0.17.0"
}

Logs

Paste any relevant application logs here.
kimminw00 commented 6 months ago

Is there any progress on this issue?

jsoref commented 6 months ago

Nope. You're welcome to work on this. It's purely about adding documentation.