| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Open | None | T209872 epic: frtech onwiki documentation overhaul | |||
| Resolved | None | T296344 Documentation: Create a place for text source for UML diagrams, and put existing diagrams there |
Event Timeline
@AndyRussG, I was looking at our existing repos and I can't see one that stands out as a home for all diagrams. We could add a 'diagrams' dir to our individual projects and then drop in the UML text definitions into txt files and share them that way... however I'm leaning more towards a new shiny 'fr-tech-diagrams' repo where we can add a folder for each subject/project and have them all in one place. I feel like this would be nicer to link to from our new docs structure also. What do you think?
Sounds great! Yeah two more reasons for doing it that way would be that some diagrams will cover processes that involve multiple codebases, and also having a single place to look to check things are up-to-date feels more effective. If we feel it's helpful, I guess we can also add a note in each repo's README about where to find related diagrams (and other doc, too)?
(BTW we can create personal repos on the new WMF Gitlab instance... just in case that's useful as a quick place to start...)
I've made a start on this and created fr-tech-diagrams over on gitlab. I had to create it as a personal repo like you said after creating it on the fr-tech group didn't work for me, I got this error. Once we figure that out let's move it over to the fr-tech group.
It probably makes sense to agree to some basic guidelines on how we add and manage the files going forward. I've added some basic instructions for converting the UML text definitions to diagrams.