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

docs: Update Draft TRG 1-4 #429

Merged
merged 7 commits into from
Nov 8, 2023
Merged

docs: Update Draft TRG 1-4 #429

merged 7 commits into from
Nov 8, 2023

Conversation

FaGru3n
Copy link
Contributor

@FaGru3n FaGru3n commented Oct 24, 2023

Description

  • add reference to draw.io
  • add draw.io example

fixes #427

ongoing IP-Validation Checks

Preview

image

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@FaGru3n FaGru3n changed the title docs: Update Draft TRG 1 docs: Update Draft TRG 1-4 Oct 24, 2023
Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@FaGru3n to be honest i am not sure if a change is needed :)

docs/release/trg-0/trg-1-4.md Outdated Show resolved Hide resolved
@Siegfriedk
Copy link
Contributor

We need to clarify this TRG a little bit more:

Generally speaking i don't think its enough to just have a *.svg file available because, while you can change it (its plain text) without knowhing which tool you used to generate it, you can't really change it. You can fix existing text, you might be able to update some lines etc. but not 'change' the content.

We might even make it mandatory to have a short section in the README.md to clarify which tool they use. draw.io for example is a good option but if you need a speicifc version you might need to document how to use it with something like a container image we host ourselfes and we need to align on a version.

@stephanbcbauer
Copy link
Member

We need to clarify this TRG a little bit more:

Generally speaking i don't think its enough to just have a *.svg file available because, while you can change it (its plain text) without knowhing which tool you used to generate it, you can't really change it. You can fix existing text, you might be able to update some lines etc. but not 'change' the content.

We might even make it mandatory to have a short section in the README.md to clarify which tool they use. draw.io for example is a good option but if you need a speicifc version you might need to document how to use it with something like a container image we host ourselfes and we need to align on a version.

@Siegfriedk not sure if this helps, but at least in the SVG file which were created by draw.io there is always this note in the header
image

@FaGru3n
Copy link
Contributor Author

FaGru3n commented Oct 30, 2023

bfdc244

@FaGru3n FaGru3n dismissed stephanbcbauer’s stale review October 30, 2023 11:24

outdated branch that was checked

@FaGru3n FaGru3n self-assigned this Oct 30, 2023
Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM Thank you

@FaGru3n
Copy link
Contributor Author

FaGru3n commented Oct 31, 2023

I will wait for @Siegfriedk for the approval before merge 😉

Copy link
Contributor

@SebastianBezold SebastianBezold left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think if we want to restrict contributors to specific tools, then we need to provide more guidance.
Alternative would be only mention the tools as valid options (golden path) and only have mandatory guidelines, like:

  • You need to contribute the "raw" editable source
  • Used tools need to be usable by anyone without the need of a licence or similar (prefer open source tools)
  • Tools should be OS independent

and so on

docs/release/trg-0/trg-1-4.md Outdated Show resolved Hide resolved
docs/release/trg-0/trg-1-4.md Outdated Show resolved Hide resolved
@FaGru3n
Copy link
Contributor Author

FaGru3n commented Nov 8, 2023

updated my branch current view:

@FaGru3n FaGru3n merged commit 9b1b3e3 into main Nov 8, 2023
@FaGru3n FaGru3n deleted the chore/trg-update branch November 8, 2023 12:11
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

Successfully merging this pull request may close these issues.

feat(trg-1-4): Adapt and add use of draw.io
4 participants