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

Investigate if standard icons are available for immediate use in the Toolkit #207

Closed
awschristou opened this issue Jan 25, 2019 · 1 comment
Labels
documentation guidance General information and guidance, answers to FAQs, or recommended best practices/resources.

Comments

@awschristou
Copy link
Contributor

  • Are there icons that we have access (eg a common source) to that we are allowed to use in the toolkit
  • produce a comprehensive list of icons (services and commands) to request from UX
@awschristou
Copy link
Contributor Author

awschristou commented Feb 2, 2019

We currently do not have a central collection of icons we can draw from in an api fashion. When other open source repos (with compatible licensing models, such as MIT) have svg assets that would provide a consistent UI experience in the Toolkit, we plan to copy them into this repo using the following approach:

  • A separate location in this repo is used for every repo where images are sourced from. The location is in the form third-party/resources/from-<BRIEF_REPO_NAME>
  • Copy the source repo's licence into this destination location's LICENSE.txt file
  • Create a README.md in the destination location, and type in a copyright attribution:
The AWS Toolkit for VS Code includes the following third-party software/licensing:

Icons contained in this folder and subfolders are from <SOURCE_REPO_NAME>: <SOURCE_REPO_URL>

<PASTE_SOURCE_LICENSE_HERE>
  • Copy the SVG file(s) into a suitable place within the destination location, for example .../dark/xyz.svg and .../light/xyz.svg
  • Add an entry to third-party/README.md summarizing the new destination location, where the asserts were sourced from, and a brief rationale.

PR #227 illustrates what this looks like in practice.

@awschristou awschristou added documentation guidance General information and guidance, answers to FAQs, or recommended best practices/resources. labels Feb 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation guidance General information and guidance, answers to FAQs, or recommended best practices/resources.
Projects
None yet
Development

No branches or pull requests

1 participant