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

Include guidelines for adding diagrams/graphics source files #117

Open
sjay72 opened this issue Feb 11, 2019 · 1 comment
Open

Include guidelines for adding diagrams/graphics source files #117

sjay72 opened this issue Feb 11, 2019 · 1 comment

Comments

@sjay72
Copy link
Contributor

sjay72 commented Feb 11, 2019

Recommendation: Community projects should possess and maintain source files for any diagrams or images, whether they are used for internal discussions, in the upstream documentation, or as the "mock-up" for the creation of RH-style images created by CCS for use downstream.

Scenario that inspired this guideline:

  • Devs created diagrams to use in the upstream documentation, but did not add source files to the repo.
  • A Dev shared the .png "output" with a CCS writer for modification by a RH graphics person.
  • CCS writer contributed the RH-style image ouput back to the Community (sans all indication of being touched by RH)
  • Devs now want to iterate on the diagrams for functionality they're adding to their project/product. However, they are starting from scratch, as no source of the originals was ever added to the Community repo.
  • Providing source from RH-created diagrams is probably not viable due to tools-compatibility reasons. And may have legal concerns around that, but I'm not sure.
@pmkovar
Copy link
Member

pmkovar commented Feb 20, 2019

Should also add that the generally preferred source format for vector graphics is SVG.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants