-
Notifications
You must be signed in to change notification settings - Fork 3
docs: restructure docs and update branding #35
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
Conversation
Reviewer's GuideRebrands the documentation site to “ELIXIR-on-Cloud” and restructures the MkDocs content/navigation into topic-based sections (General, Sandbox, Services, Tutorials, Contribute, About), updating page locations, links, and section landing pages accordingly. Flow diagram for updated MkDocs navigation structureflowchart TD
Home[index]
Home --> General
Home --> Sandbox
Home --> Services
Home --> Tutorials
Home --> Contribute
Home --> About
General --> GeneralIndex[general/index]
General --> GA4GHCloudWorkstream[general/ga4gh_cloud]
General --> SensitiveData[general/sensitive_data]
General --> UserStories[general/user_stories]
Sandbox --> SandboxIndex[sandbox/index]
Services --> ServicesIndex[services/index]
Services --> CloudRegistry[services/cloudregistry]
Services --> CWLWES[services/cwlwes]
Services --> DRSFiler[services/drsfiler]
Services --> Funnel[services/funnel]
Services --> LSLogin[services/services_to_ls_aai]
Services --> proWES[services/prowes]
Services --> proTES[services/protes]
Services --> TESK[services/tesk]
Services --> TRSFiler[services/trsfiler]
Tutorials --> TutorialsIndex[tutorials/index]
Tutorials --> SPEBasedOnWES[tutorials/sensitive_data_analysis]
Tutorials --> Crypt4GHWithProTES[tutorials/crypt4gh_to_protes]
Contribute --> ContributeIndex[contribute/index]
Contribute --> Workflow[contribute/workflow]
Contribute --> GeneralGuidelines[contribute/general-guidelines]
Contribute --> ManagingProjects[contribute/managing-projects]
Contribute --> LangSpecific[contribute/language-specific/index]
LangSpecific --> Python[contribute/language-specific/python]
About --> Contact[about/contact]
About --> License[about/license]
About --> CodeOfConduct[about/code-of-conduct]
About --> Privacy[about/privacy]
About --> Imprint[about/imprint]
About --> Acknowledgements[about/acknowledgements]
Flow diagram for file moves from guides to new structureflowchart LR
subgraph OldGuides
OGIndex[guides/index]
OGUserIndex[guides/guide-user/index]
OGUserStories[guides/guide-user/user_stories]
OGAdminCWLWES[guides/guide-admin/cwlwes]
OGAdminSDA[guides/guide-admin/sensitive_data_analysis]
OGAdminServicesToLSAAI[guides/guide-admin/services_to_ls_aai]
OGContributorIndex[guides/guide-contributor/index]
OGContributorWorkflow[guides/guide-contributor/workflow]
OGContributorGeneral[guides/guide-contributor/general-guidelines]
OGContributorManaging[guides/guide-contributor/managing-projects]
OGContributorLangIndex[guides/guide-contributor/language-specific/index]
OGContributorPython[guides/guide-contributor/language-specific/python]
end
subgraph NewStructure
NGGeneralIndex[general/index]
NGGA4GHCloud[general/ga4gh_cloud]
NGUserStories[general/user_stories]
NGSandboxIndex[sandbox/index]
NGServicesIndex[services/index]
NGCWLWES[services/cwlwes]
NGServicesToLSAAI[services/services_to_ls_aai]
NGTutorialsIndex[tutorials/index]
NGSDA[tutorials/sensitive_data_analysis]
NGCrypt4GH[tutorials/crypt4gh_to_protes]
NGContributeIndex[contribute/index]
NGWorkflow[contribute/workflow]
NGGeneralGuidelines[contribute/general-guidelines]
NGManagingProjects[contribute/managing-projects]
NGLangIndex[contribute/language-specific/index]
NGPython[contribute/language-specific/python]
end
OGUserIndex --> NGSandboxIndex
OGUserIndex --> NGGA4GHCloud
OGUserStories --> NGUserStories
OGAdminCWLWES --> NGCWLWES
OGAdminSDA --> NGSDA
OGAdminServicesToLSAAI --> NGServicesToLSAAI
OGContributorIndex --> NGContributeIndex
OGContributorWorkflow --> NGWorkflow
OGContributorGeneral --> NGGeneralGuidelines
OGContributorManaging --> NGManagingProjects
OGContributorLangIndex --> NGLangIndex
OGContributorPython --> NGPython
Flow diagram for branding updates across documentationflowchart LR
subgraph OldBranding
OBName1[ELIXIR_Cloud_and_AAI]
OBName2[ELIXIR_double_colon_GA4GH_Cloud]
end
subgraph NewBranding
NBName[ELIXIR_on_Cloud]
end
OBName1 --> NBName
OBName2 --> NBName
subgraph AffectedLocations
MKDocsYML[mkdocs_yml_site_name_copyright_social]
Custom404[custom_theme_404_html_titles_labels]
DocsIndex[docs_index_md_landing]
ContributeIndex[docs_contribute_index_md]
CWLWES[docs_services_cwlwes_md]
ServicesToLSAAI[docs_services_services_to_ls_aai_md]
CodeOfConduct[docs_about_code_of_conduct_md]
README[README_md]
end
NBName --> MKDocsYML
NBName --> Custom404
NBName --> DocsIndex
NBName --> ContributeIndex
NBName --> CWLWES
NBName --> ServicesToLSAAI
NBName --> CodeOfConduct
NBName --> README
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR reorganizes the MkDocs documentation structure and updates project branding from "ELIXIR Cloud & AAI" / "ELIXIR::GA4GH Cloud" to "ELIXIR-on-Cloud".
Changes:
- Restructured documentation navigation into six top-level sections: General, Sandbox, Services, Tutorials, Contribute, and About
- Updated all branding references from "ELIXIR Cloud & AAI" and "ELIXIR::GA4GH Cloud" to "ELIXIR-on-Cloud"
- Added comprehensive index.md files for each major section with summaries and navigation aids
Reviewed changes
Copilot reviewed 20 out of 36 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Updated site name, navigation structure, copyright, and social media references to use new branding and folder layout |
| docs/index.md | Updated landing page with new branding and updated navigation links to reflect new folder structure |
| docs/tutorials/* | Added new tutorial section with two comprehensive guides on secure genomic analysis (Crypt4GH integration and SPE setup) |
| docs/services/* | Moved and added service deployment documentation (TESK, Funnel, proTES, proWES, DRS-Filer, TRS-Filer, Cloud-Registry, CWL-WES, LS Login) |
| docs/general/* | Created new general section with GA4GH Cloud overview, sensitive data processing guidelines, and user stories |
| docs/contribute/* | Moved contributor documentation with updated internal links |
| docs/sandbox/index.md | Added placeholder for sandbox/user guide section |
| custom_theme/404.html | Updated 404 page branding |
| README.md | Updated project description with new branding |
Comments suppressed due to low confidence (8)
docs/contribute/index.md:72
- The word "exiciting" is misspelled and should be "exciting".
docs/general/ga4gh_cloud.md:113 - The word "environements" is misspelled and should be "environments".
docs/general/ga4gh_cloud.md:114 - The word "accross" is misspelled and should be "across".
docs/general/ga4gh_cloud.md:120 - The word "retrievess" should be "retrieves" (extra 's' at the end).
docs/general/ga4gh_cloud.md:132 - The word "worflows" is misspelled and should be "workflows".
docs/tutorials/sensitive_data_analysis.md:47 - The word "evironment" is misspelled and should be "environment".
docs/contribute/language-specific/python.md:9 - The word "exclusing" is misspelled and should be "excluding".
docs/contribute/index.md:64 - The word "involvment" is misspelled and should be "involvement".
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
uniqueg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good stuff!! 🙏 Just a few minor comments
uniqueg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - thanks a lot! 🙏
This PR reorganizes the MkDocs documentation into a new top-level structure and updates project branding from “ELIXIR Cloud & AAI” / “ELIXIR::GA4GH Cloud” to “ELIXIR-on-Cloud”.
Summary by Sourcery
Restructure the documentation into a new top-level navigation and folder layout while updating all visible branding from “ELIXIR Cloud & AAI” / “ELIXIR::GA4GH Cloud” to “ELIXIR-on-Cloud”.
Documentation: