Skip to content

Conversation

@jmchilton
Copy link
Member

... 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.

@shiltemann
Copy link
Member

@jmchilton awesome, thanks!

For the ordering, you can set e.g. priority: 2 on the tutorial metadata to specify the order within the subtopic. But your solution is also fine, as you prefer.

As for the test error, I updated the link in the writing tests tutorial to point to the subtopic page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants