Docs/sphinx site migration#35
Open
yreyricord wants to merge 35 commits into
Open
Conversation
…#19) - Issue forms: bug report, feature request, algorithm proposal, documentation, and security report - Disable blank issues and link to docs and Discussions - Add pull request template aligned with triaged backlog workflow - Add good-first-issue welcome comment template Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr> Co-authored-by: yreyricord <yoann.rey-ricord@acri-st.fr>
Initial migration of the BIOMASS BPS documentation into the repository. PyData Sphinx Theme with MyST parser. Content covers: about, applicable documents, contributing workflow, code of conduct, contributor process, issue and PR templates reference, developer guide (architecture, code and documentation standards), getting started, governance (with communication, release process), placeholder science guide and tutorials, user guide pointing to the official SUM. GitHub Discussions setup tutorial and 6 categories referenced throughout. Internal links replace previous external biomass-disc.info pointers. Path convention aligned on test/ (singular). Em-dashes removed across the source tree. The docs/_build/ and docs/.venv/ directories are gitignored. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
…rney narrative Step 1 of aligning the Contributing pages with the PowerPoint Open Source strategy deck. * Rename the page from 'Contributing to BIOMASS L2 Processors' to 'Understanding the project'. * Replace the textual table of contents and the duplicated 'read this entire section' line with a single concise intro. * Add a 'Contribution journey at a glance' mermaid diagram covering the three phases (Before the PR, Building the PR, After the PR) with the approval gate highlighted in amber. * Collapse the three external-redirect sections (Licensing, Code of Conduct, Governance) into a 'Foundations' card grid with internal Sphinx links replacing the dead biomass-disc.info/docs/X pointers. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
flowchart LR becomes flowchart TD so the three phases (Before the PR, Building the PR, After the PR) stack top to bottom. The approval gate sits between phase 1 and phase 2, the CI status diamond between phase 2 and phase 3. Reads better on narrow screens. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
…oint slide 28 Step 2 of aligning the Contributing pages with the PowerPoint deck. * Replace the dense 22-node mermaid flowchart with a 3-card grid that shows Tier 0 (Baseline), Tier 1 (Extended), and Tier 2 (Heavy) side by side, each with its triggers, approval count and CI stages. * Move Tier 3 to its own short subsection since it is not part of the CI auto-classification; it is a governance category. * Add a 'Judge from base, never from PR' callout that promotes the core security guarantee from a buried sentence to its own important block. * Replace the giant 9-row comparison table with a compact 5-row at-a- glance summary that focuses on what contributors actually act on (CI stages, approvals, volume, timeline, review cadence). Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
…n step cards The plain-text 5-step block in the Contributing index relied on box-drawing characters and broke at narrow widths. Replace it with a vertical sphinx-design card grid that mirrors the journey mermaid underneath. Step 3 uses sd-border-warning to match the amber gate of the diagram. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
The 'Before the PR' slide shows two paths: pick an existing approved issue from the backlog (Path A) or open a new one (Path B). Path B unfolds into a 4-step scientific review process (Open, SME assignment, Scientific review, Go/no-go) with iterate and rejected branches. Replace the previous flat 5-node mermaid with a richer flowchart that makes the backlog, the SME loop, and the iterate/reject/approved branches explicit. Add a 4-card grid below detailing the Path B steps for fast scanning. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
The 'Building the PR' slide walks the contributor through five visual steps from an issue in hand to a live PR. Replace the bare numbered list with a 5-card sphinx-design grid (Fork, Implement, Local checks, Commit signed off, Open PR), each card scoped to one decision. The last card uses sd-border-success to signal the milestone (PR live). Add a tip callout pointing at the local CI mirror command so contributors catch errors before pushing. Collapse the previous 'Workflow concepts' and 'The editing process' sections into a single conventions list; they duplicated each other. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
…n.md The 'After the PR' slide tells two parallel stories: a green Path A that runs Review, Approve, Merge, Released (with DOI), and a red Path B that loops through Read log, Iterate, Re-run back to CI. Replace the flat 8-node mermaid with two subgraphs (green and red) that make the success and failure narratives visually distinct. Add explicit numbering inside each path and a callout about stale approvals being dismissed on every push. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
… page Slide 27 banner (10 baseline checks, 3 tier levels, 1 source of truth, 100% auto-classified) becomes a 4-card grid at the top of the page, under a new 'Verify every change, automatically' section. Each card uses sd-fs-2 to give the headline number visual weight. Slide 29 (Branch protection and approvals) replaces the previous markdown table with a 4-card grid (Fork, develop, release, main) coloured by protection level (light, info, warning, danger). The rules enforced everywhere become a short bullet list, and the two release-related warnings move into an important callout for visibility. Also drops the 'Pull Request' tier 3 sentence from the lead-in to keep the focus on the automated journey. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
The PyData announcement bar inherited a flat default colour that did not match the rest of the BPS theme. Replace it with a horizontal ESA-blue gradient (start at the primary, end at the link colour) and white text, with hover highlights on inline links. The gradient swaps to a darker pair in dark mode so the bar keeps contrast with the navbar. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
The Steering Council bullet lists captured only the BPS-specific roles. The official BIOMASS DISC organisation chart shows many more people: service management, the BioPAL/Open Science Office, scientific coordination, the full ESL Network, and the Technical Office. Replace the three bullet lists with a structured table that recaps the BPS Steering Council first (since it is the BPS-specific governance), then adds a section 'Where BPS sits in the BIOMASS DISC organisation' that mirrors the official chart, one sub-table per area, colour-coded emoji matching the chart palette. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
The previous ESA-only blue gradient did not communicate the Open Science welcoming tone the announcement carries. Swap the two stops for the ACRI palette: Blue ACRI (#347891) on the left and Green ACRI (#9EBE3D) on the right. White text stays in place. Dark mode uses darker counterparts (#1f4a59, #6f8b2b) so the bar still reads on the dark navbar. Variables remain in :root for easy tweaks. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
Split monolithic docs into navigable sections with grouped sidebars, add Communication as its own area, slim governance to stewards and processor ownership, merge developer-guide content into Contributing, and restore CODEOWNERS plus minor theme/build fixes. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
Configure html_baseurl and site_home_url for subpath serving, add a top banner with a return link to the main site, and pin the Edit on GitHub branch via SPHINX_GITHUB_VERSION. Signed-off-by: Yoann Rey-Ricord <yreyricord@hrz-ub-0019.acri.local>
Align the site with BioPAL violet/accent colors across links, sidebar, heading anchors, prev/next, and footer credits. Replace decorative emojis with Font Awesome icons, restyle homepage and Get Started entry points, and switch workflow/stat cards to horizontal layouts for readability. Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
yreyricord
temporarily deployed
to
biomass-disc-prod
GitHub Actions
Inactive
yreyricord
temporarily deployed
to
biomass-disc-prod
GitHub Actions
Inactive
Add the L2 AGB ATBD as a browsable Science Guide chapter with BibTeX citations, collapsible sidebar TOC, and CI-built web-export PDF. Ship the Run BPS locally tutorial bundle, homepage hero with version badge from the latest bps-v* tag, section hub navigation polish, and LaTeX/tag-aware docs CI.
The ATBD LaTeX export requires tgtermes/tgheros (TeX Gyre), provided by texlive-fonts-extra on Ubuntu CI runners.
Override Sphinx default TeX Gyre fonts so `make atbd-pdf` succeeds on Ubuntu runners with texlive-fonts-recommended only.
Use built-in Computer Modern so CI needs no TeX Gyre or lmodern packages.
Switch the web-export PDF to xelatex + DejaVu fonts so Greek symbols and inequality signs in ATBD body text compile on CI.
Fix appendix eq. 5.1 for LaTeX (equation env instead of split+tag) and allow the PDF step to fail without blocking the HTML GitHub Pages build.
Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
…iopal Documentation Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
Signed-off-by: Yoann Rey-Ricord <yreyricord@hrz-ub-0019.acri.local>
…ontributors Signed-off-by: yreyricord <yoann.rey-ricord@acri-st.fr>
…are removed due to not covering the l2b tile_id
…k writing (happening with fd first cycle products)
yreyricord
force-pushed
the
docs/sphinx-site-migration
branch
from
f415b97 to
564f415
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
docs/with PyData theme, MyST, BibTeX, and BioPAL branding.bps-v*git tag.fetch-tags, andmake atbd-pdf.Test plan
Linked issue
Closes #22
Notes for reviewers
develop.Documentation
Expected tier
0 — documentation-only changes under
docs/and.github/workflows/docs.yml.