Skip to content

Update pipeline documentation - #1697

Open
tteggelit wants to merge 4 commits into
Ramble-Project:developfrom
tteggelit:pipeline_docs
Open

tteggelit wants to merge 4 commits into
Ramble-Project:developfrom
tteggelit:pipeline_docs

Conversation

@tteggelit

Copy link
Copy Markdown
Contributor

This:

  • Adds a new Basics section to introduce a typical Ramble workspace workflow and the concepts of pipelines and phases
  • Updates the Advanced section on pipelines with more information and diagrams to help explain the flow
  • Updates the docs conf.py for graphviz to remove global rank direction and sets the fonts to something less Mac specific

Attaching PDFs of the new pages to make it a bit easier to see the results without people needing to checkout my branch and run Sphinx against it.
Basics - Pipelines and Phases.pdf
Advanced - Pipelines and Builtins.pdf

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request significantly expands and restructures the documentation regarding Ramble's pipelines and phases. It introduces a new pipelines.rst file detailing common workspace workflows, updates advanced_topics.rst with architectural overviews and phase graphs, integrates Graphviz diagrams to visualize these workflows, and updates Sphinx configuration settings. The review feedback suggests minor grammatical and phrasing corrections to improve readability, such as removing a redundant "below", correcting "usecases" to "use cases", and adding a missing article.

Comment thread lib/ramble/docs/dev_guides/advanced_topics.rst
Comment thread lib/ramble/docs/dev_guides/advanced_topics.rst Outdated
Comment thread lib/ramble/docs/pipelines.rst Outdated

@rfbgo rfbgo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dcoapp recheck

@tteggelit
tteggelit force-pushed the pipeline_docs branch 2 times, most recently from 7432f6d to 3296c9a Compare September 8, 2026 14:20
@rfbgo

rfbgo commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

/gcbrun

1 similar comment
@dapomeroy

Copy link
Copy Markdown
Collaborator

/gcbrun

@ramble-project-pr-bot

ramble-project-pr-bot Bot commented Sep 14, 2026

Copy link
Copy Markdown

Ramble Performance Test Metrics

Results produced with commit: ec9fbef

Test Name Outcome Duration (s) Most Recent Run (s) Last 5 Avg (s)
test_analyze_large_file passed 1.0688 1.0692 (9579363) 1.0803
test_large_template_expansion passed 1.1841 1.1624 (9579363) 1.1801
test_many_experiments passed 23.1021 22.8528 (9579363) 23.4535
test_many_objects_defaults passed 12.0621 11.8598 (9579363) 12.2550
test_matrix_filter_perf passed 1.0601 1.0384 (9579363) 1.0842

@tteggelit
tteggelit marked this pull request as draft September 14, 2026 18:38
tteggelit and others added 4 commits September 14, 2026 13:41
Signed-off-by: Ti Leggett <tileggett@google.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Ti Leggett <tileggett@google.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Ti Leggett <tileggett@google.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Ti Leggett <tileggett@google.com>
@tteggelit
tteggelit marked this pull request as ready for review September 14, 2026 18:47
@douglasjacobsen

Copy link
Copy Markdown
Collaborator

/gcbrun

@codecov

codecov Bot commented Sep 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@tteggelit

Copy link
Copy Markdown
Contributor Author

The Docker image won't get rebuilt based on the new Dockerfiles until the PR is merged, so the doc build test is still using the old image that doesn't have graphviz included. Verified that adding graphviz does allow the doc build test to complete. I can split the Dockerfile updates into their own PR to force an image rebuild and then have this one re-run the tests after that if that is more desirable.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants