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

TRG 1.04 editable static files #91

Closed
Tracked by #88
FaGru3n opened this issue Feb 19, 2024 · 4 comments · Fixed by #104
Closed
Tracked by #88

TRG 1.04 editable static files #91

FaGru3n opened this issue Feb 19, 2024 · 4 comments · Fixed by #104
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@FaGru3n
Copy link
Contributor

FaGru3n commented Feb 19, 2024

Hi all, found some various screenshots and also some sequence diagramms within .png format that could have to be editable like described in https://eclipse-tractusx.github.io/docs/release/trg-1/trg-1-4/

so i would suggest file like a

All diagram files must be either using code to generate diagrams, or stored as .svg file within our repositories

This includes:
diagrams
flowcharts
sequence diagrams
state diagrams
gantt charts
etc.

@fabiodmota
Copy link
Contributor

fabiodmota commented Feb 19, 2024

Hi Fabian , most of our images png and svg files were done to document first guidelines , all new images since the TRG release are on mermaid or other tools that can be editable

@FaGru3n
Copy link
Contributor Author

FaGru3n commented Feb 20, 2024

Hi @fabiodmota ,

sure no problem for the "userguide-pics.png" it is more related to your diagram files.

same examples that are diagramms and as stated in our TRG:

All diagram files must be either using code to generate diagrams, or stored as .svg file within our repositories.

some examples:

so easiest way would be rechecking on diagram files and store it as .svg but better would be dedicates .puml or .mmd / .mermaid files

@FaGru3n
Copy link
Contributor Author

FaGru3n commented Feb 26, 2024

Found also some sequence diagramms that could be easily adopted with mermaid

for example and all other "DashBoardRessource_xxxxx" could also be modified.
https://github.com/eclipse-tractusx/vas-country-risk/blob/main/docs/Images/DashBoardResource_getAllDashBoardTable.jpg

@FaGru3n
Copy link
Contributor Author

FaGru3n commented Feb 26, 2024

For our current state i would check this item in the QG-Checks Tasklist, because now i think you get the point to update your diagrams into editable files and will leave this issue open if you have further questions and feedback how to update you "editable diagram files" 😉

@FaGru3n FaGru3n added the documentation Improvements or additions to documentation label Feb 26, 2024
@FaGru3n FaGru3n closed this as completed Feb 26, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done in Country Risk Kanban Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

2 participants