Skip to content

Document predefined emoji/icon images #8344

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

Closed
bpmct opened this issue Jul 6, 2023 · 17 comments · Fixed by #10093 or #10230
Closed

Document predefined emoji/icon images #8344

bpmct opened this issue Jul 6, 2023 · 17 comments · Fixed by #10093 or #10230
Assignees
Labels
site Area: frontend dashboard

Comments

@bpmct
Copy link
Member

bpmct commented Jul 6, 2023

When adding a workspace proxy, setting an icon for Coder app, etc you can set an icon URL. Right now, power users know to go to the template settings page to see the icon picker and get the right URL.

Can we add a https://coder.example.com/icons which just has the icon picker component so they can easily get an icon URL? It would also be nice if it statically rendered the paths for stuff like VS Code, JetBrains, and other icons we statically host. Then, in the wsproxy create help text and UI (and in the terraform provider docs) we can tell people to navigate there to see available icons.

@bpmct bpmct added the site Area: frontend dashboard label Jul 6, 2023
@cdr-bot cdr-bot bot added the feature label Jul 6, 2023
@BrunoQuaresma
Copy link
Collaborator

BrunoQuaresma commented Aug 9, 2023

Not sure if I got it 🤔 do you have any mocks?

@bpmct
Copy link
Member Author

bpmct commented Aug 16, 2023

Ah sorry! Several elements in Coder templates require an icon URL which is often an emoji in our /emojis or icon in /icons. However, there is not a good way to browse and search all icons except by going to the template settings page (+ it only shows emoji). It'd be cool to have a basic static site that helps the user pick an emoji that we can link to in docs + template comments.

Screenshot 2023-08-16 at 12 44 04 PM

@aslilac
Copy link
Member

aslilac commented Aug 18, 2023

I think it'd be a bit nice to integrate this into the UI, rather than telling users "go find one over here and then come back"

Looks like the picker component we use supports custom emojis/images/icons/whatever as well

@aslilac
Copy link
Member

aslilac commented Aug 18, 2023

@bpmct can you think of any other places in the app where we should be showing a "picker" for this sort of thing but don't currently?

@BrunoQuaresma
Copy link
Collaborator

I think this is more for when users are setting emojis and icons on TF configuration

@aslilac
Copy link
Member

aslilac commented Aug 21, 2023

ah ok, that makes sense

@bpmct
Copy link
Member Author

bpmct commented Aug 21, 2023

I think this is more for when users are setting emojis and icons on TF configuration.

Yeah agreed so I think it is fine as a detached page since most people will go to it from code comments. Cool that it supports icons too!

Another idea is to show this on our docs or coder.com but then it may drift across versions and not work for our enterprise customers offline networks

@aslilac
Copy link
Member

aslilac commented Aug 21, 2023

Another idea is to show this on our docs or coder.com but then it may drift across versions and not work for our enterprise customers offline networks

I've seen some stuff in the code base around offline docs but I don't exactly have all the context there. We could also just do both, especially if we could generate them from the same source of truth to prevent drift. Meet people where they're at, make things like this as discoverable as we can.

@aslilac aslilac changed the title Add route for icon picker Document predefined emoji/icon images Aug 22, 2023
@matifali
Copy link
Member

I like https://devicons.railway.app/

@aslilac
Copy link
Member

aslilac commented Sep 27, 2023

I especially like that they have some language icons in there (Rust, Go, TS). I think we could benefit from those as well, so that you could have multiple Docker templates with better icons.

@bpmct
Copy link
Member Author

bpmct commented Sep 27, 2023

Agreed!

@matifali
Copy link
Member

matifali commented Oct 9, 2023

@aslilac, is it at /icon or /icons?
When we use builtin icons in our templates, we use the /icon path.

Also, let us keep this open until we document how to use this.

@matifali matifali reopened this Oct 9, 2023
@aslilac
Copy link
Member

aslilac commented Oct 9, 2023

which is why it can't be /icon. that would be a routing conflict. plus it just sounds weird.

@matifali
Copy link
Member

matifali commented Oct 9, 2023

Or we can just rename it to /icons and mark as a breaking change. As it will need app users to update their templates.
Thoughts @bpmct ?

@aslilac
Copy link
Member

aslilac commented Oct 9, 2023

that would also be a routing conflict. 😅

@aslilac
Copy link
Member

aslilac commented Oct 9, 2023

what places exactly do we need to document this to close the issue?

@matifali
Copy link
Member

matifali commented Oct 9, 2023

TBH, it's not very clear at the moment. Maybe someplace in https://coder.com/docs/v2/latest/templates or we can wait for this significant refactoring to merge,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
site Area: frontend dashboard
Projects
None yet
4 participants