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

Official AWS/GCP/Azure architecture icons #6109

Open
loozhengyuan opened this issue Dec 4, 2024 · 2 comments
Open

Official AWS/GCP/Azure architecture icons #6109

loozhengyuan opened this issue Dec 4, 2024 · 2 comments
Labels
Status: Triage Needs to be verified, categorized, etc

Comments

@loozhengyuan
Copy link

loozhengyuan commented Dec 4, 2024

Context

The new architecture diagram is a refreshing addition to Mermaid and my team are looking to replace all our cloud architecture diagrams with Mermaid.js. We are deeply integrated with AWS services so having the full set of architecture icons for the major cloud service providers like AWS, GCP, Azure, etc., will be a very positive experience for diagram creators.

Issue

At present, the native icons are sourced from Iconify. I have tried to request support for these icons through them in iconify/icon-sets#152 but was unsuccessful. The existing set of AWS icons in Iconify are sourced from the logos icon set and I have tried to request for the full set to be added in gilbarbara/logos#733 but they were understandably unwilling to add all icons en masse.

With that, it leaves me with the option of adding my own custom icons but it is not something viable. In most of our work, the Mermaid diagrams are rendered on public collaborative platforms like GitHub, GitLab, Confluence, etc., so it is not something configurable by the users.

Proposal

I am not certain what is the best way forward but having a set of ready-to-use architecture icons like in DrawIO will be a big draw factor for Mermaid architecture diagrams. I have 2 proposed ideas that could help resolve this issue but will defer to your consideration and judgement:

  • Work with AWS/GCP/Azure to have official icon set and support it out-of-the-box in Mermaid
  • Allow users to inline custom icons directly in the syntax

Many thanks!

@github-actions github-actions bot added the Status: Triage Needs to be verified, categorized, etc label Dec 4, 2024
@mgrubb
Copy link

mgrubb commented Dec 12, 2024

I had this same desire, though I didn't necessarily need to have them hosted on a CDN or other external source. I'm not sure about licensing with regards to distributing the AWS Icons, but I do have a set of scripts that will take the icons from https://aws.amazon.com/architecture/icons/ and generate an iconify icon set. The process is a bit slap dash at the moment, but shouldn't take much to be repeatable. It does some name mapping but could probably simplified a bit. I'll try and get some things collected and post a link to a repo.

@hakanson
Copy link

I just learned icons are supported in Mermaid. I'm a maintainer for aws-icons-for-plantuml and have some scripts that process the AWS icon set for use in PlantUML (and a Structurizr theme).

Over holiday break, I'm going to tweak https://github.com/awslabs/aws-icons-for-plantuml/blob/main/scripts/icon-builder.py#L835-L838 and see if I can output the correctly formatted JSON file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc
Projects
None yet
Development

No branches or pull requests

3 participants