search

awslabs / aws-icons-for-plantuml

PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
Other
902 stars 152 forks source link

Fixed icon-builder.py case typo that caused --check-env to fail #21

Closed Crashedmind closed 4 years ago

Crashedmind commented 4 years ago

Issue #, if available:

Description of changes: Problem When "icon-builder.py --check-env" is run, it fails because it's looking for AWScommon.puml. However, what's there is "AWSCommon.puml" Also, some minor typos in MARKDOWN_PREFIX_TEMPLATE

Solution Change the script to look for "AWSCommon.puml. Fix minor typos in MARKDOWN_PREFIX_TEMPLATE

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Crashedmind commented 4 years ago

cool - thanks for accepting the PR.

I had some other ideas - I can submit these via PRs also if you think these are useful e.g.

  1. in addition to the symbols.md, create a puml file per category in dist/ e.g. dist/AWSCostManagement.puml that lists all the icons for that category in macro form e.g. Budgets(Budgets, "Label", "Technology",). This would then be converted to png. This is useful to see the rendered puml icons/files with colors (currently the symbols.md shows the original png - where the version rendered from puml may not look as good). Or as an alternative, use the png rendered from the puml in the symbols.md (instead of the original png)
  2. the code could be made generic with minor changes. This allows processing of other icon sets. In the past I contributed the Open Security and Elastic icon set to the plantuml Stdlib (using AWS-PlantUML as the learning/starting point).
  3. port the scripts to a github action and workflow - so anyone can push png files to their repo, and the puml files will be auto-generated and committed to their repo (with tests and CI/CD as part of that).

Anyway, you get the idea.... I don't have any affiliation with plantuml - but do use it and C4 a lot.

gadams999 commented 4 years ago

Hi @Crashedmind

I like the idea for creating a puml that when rendered shows all the icons! That shouldn't be too much of an effort to add to icon-builder process. If you want to do a PR for it, that'd be great. I would ask that we collaborate on what to add to the main README.md file to cover the new addition.

For 2 and 3, I'd say this would be better as a fork of this repository than PRs. Being this is managed by AWS, keeping the focus specific to AWS Architecture Icons is the main goal.

Licensing allows for use of the code and processes in anyway you'd like, and I'd be happy too call out your work from this repo!

Crashedmind commented 4 years ago

thanks @gadams999 - with this collaborative approach in mind, I'll compose my thoughts... into a github project board - so they can be prioritised and tracked - and PR/fork as required.

Scaling is another idea. Would be very easy to add a scaling factor as a parameter to the icon macros so user can in their puml file change the size of the icon. I've tested this... but not changed the icon-builder script to auto-generate.

https://github.com/Crashedmind/plantuml-stdlib/projects/1 is the prioritized list of features so far - with links to the details in wiki pages.