Split and Update Galaxy Architecture Slides #6602
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
... as requested by Helena in this comment #3450 (comment). It breaks each of the big sections into individual topics. I couldn't find a good way to organize them into an order in the index so I gave them titles like: "Architecture NN - Topic" to get them to sort in the right order. I also added previous / next links in the slides.
In addition to simply splitting this content I've done an overhaul of all the content for the biggest of the last 4 years of changes. I've dropped references to cloudman and added slides for galaxy-social and galaxy-codex. I've dropped gitter content and swapped it to element. I've implemented some validation of all the file diagrams so they can be checked against galaxy itself and updated all of those with new key files and dropped older files. I've swapped vuex content to pinia content. I've updated the release process description. I've also added three new sections - file source architecture, Galaxy Markdown architecture, and the architecture of tests in Galaxy.
I've waffled back and forth between whether this content belongs here or in Galaxy itself. In terms of "source of truth" - clearly the information belongs in Galaxy so PRs can update the architectural documents that describe this stuff and so we can generate documents that live in Galaxy's sphinx from this content. In terms of presentation and visibility though - the content belongs here.
Given that balance of things - I think the source of the data should live in Galaxy and this content should be generated artifacts from that documentation. So as a proof of concept - I've moved everything to a new repository jmchilton/galaxy-architecture where I can experiment with publishing the content to a sphinx document (https://jmchilton.github.io/galaxy-architecture/) with the eventual goal of getting it back into Galaxy but also generate Jekyll-compatible GTN slides as an artifact.