Skip to content

Ecosystem page for Apache Burr#661

Merged
skrawcz merged 6 commits intoapache:mainfrom
harishkesavarao:docs/ecosystem-page
Apr 5, 2026
Merged

Ecosystem page for Apache Burr#661
skrawcz merged 6 commits intoapache:mainfrom
harishkesavarao:docs/ecosystem-page

Conversation

@harishkesavarao
Copy link
Copy Markdown
Contributor

@harishkesavarao harishkesavarao commented Feb 16, 2026

[Short description explaining the high-level reason for the pull request]

Changes

Adds an ecosystem page for Apache Burr showcasing integrations, examples, and resources to help build better applications with Burr.

How I tested this

Built documentation locally:

Installing all project dependencies (pip install -e ".[docs]")
Running make html in the docs/ directory
Verifying the rendered HTML output

image

Pre-commit hooks:
Screenshot From 2026-04-02 23-11-41
Screenshot From 2026-04-02 23-19-55

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

@harishkesavarao
Copy link
Copy Markdown
Contributor Author

Implements item 2 mentioned in #589 (comment)

- `OpenAI Examples <https://github.com/apache/burr/tree/main/examples/openai-compatible-agent>`_
* - **LlamaIndex**
- Connect your custom data to LLMs.
- `LlamaIndex Integration <https://github.com/apache/burr/tree/main/examples/resource_management>`_
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.

this doesn't exist

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sorry about that, now fixed.

Comment on lines +51 to +65
* - **OpenAI**
- Build agents using OpenAI's powerful models.
- `OpenAI Examples <https://github.com/apache/burr/tree/main/examples/openai-compatible-agent>`_
* - **LlamaIndex**
- Connect your custom data to LLMs.
- `LlamaIndex Integration <https://github.com/apache/burr/tree/main/examples/resource_management>`_
* - **Haystack**
- Build end-to-end NLP pipelines.
- `Haystack Integration <https://github.com/apache/burr/tree/main/examples/haystack-integration>`_
* - **Instructor**
- Structured outputs for LLMs.
- `Instructor Examples <https://github.com/apache/burr/tree/main/examples/instructor-gemini-flash>`_
* - **Google Gemini**
- specific examples using Google's Gemini models.
- `Gemini Examples <https://github.com/apache/burr/tree/main/examples/instructor-gemini-flash>`_
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.

can you please QA these and check that the examples actually match the descriptions.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sorry about the errors, I have fixed them and have also checked the example URLs' content and the descriptions.

- specific examples using Google's Gemini models.
- `Gemini Examples <https://github.com/apache/burr/tree/main/examples/instructor-gemini-flash>`_

Orchestration & Data
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.

I think there might be haystack examples?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, added.

@@ -0,0 +1,1072 @@
<!doctype html>
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.

what's the purpose of this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It is not required, removed it.

Copy link
Copy Markdown
Contributor

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

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

see comments and address them please.

@andreahlert
Copy link
Copy Markdown
Collaborator

Nice addition. Just flagging that some links in the docs still point to burr.dagworks.io and dagworks-inc/burr (tracked in #589, PR #659 addresses part of it). Might be worth making sure any URLs in this new ecosystem page use the apache/burr references.

@harishkesavarao
Copy link
Copy Markdown
Contributor Author

Nice addition. Just flagging that some links in the docs still point to burr.dagworks.io and dagworks-inc/burr (tracked in #589, PR #659 addresses part of it). Might be worth making sure any URLs in this new ecosystem page use the apache/burr references.

Noted, will make changes accordingly.

…message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
@harishkesavarao
Copy link
Copy Markdown
Contributor Author

see comments and address them please.

@skrawcz thank you for the review, I have made changes. Can you please review the PR once more?

@harishkesavarao harishkesavarao requested a review from skrawcz March 21, 2026 16:23
Copy link
Copy Markdown
Contributor

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

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

this needs to be referenced in an index for it to be displayed. can you build the docs locally and show it being surfaced please?

@skrawcz
Copy link
Copy Markdown
Contributor

skrawcz commented Mar 26, 2026

and also run the pre-commit hooks please

@skrawcz
Copy link
Copy Markdown
Contributor

skrawcz commented Mar 26, 2026

/home/runner/work/burr/burr/docs/ecosystem.rst: WARNING: document isn't included in any toctree [toc.not_included]

is the error -- so you need to include it in an index

@andreahlert andreahlert added kind/documentation Docs, examples, notebooks area/website burr.apache.org website labels Mar 30, 2026
@harishkesavarao
Copy link
Copy Markdown
Contributor Author

and also run the pre-commit hooks please

Added a screenshot showing successful pre-commit hook runs locally.

@harishkesavarao
Copy link
Copy Markdown
Contributor Author

harishkesavarao commented Apr 2, 2026

/home/runner/work/burr/burr/docs/ecosystem.rst: WARNING: document isn't included in any toctree [toc.not_included]

is the error -- so you need to include it in an index

Added and the local build succeeded with 1 warning which is unrelated to this scenario. The warning about the document not being included in the toctree is no longer present.

WARNING: autodoc: failed to import class 'ray.RayExecutor' from module 'burr.integrations'; the following exception was raised

copying static files: done
copying extra files... 
copying extra files: done
copying assets: done
writing output... [100%] reference/visibility
generating indices... genindex py-modindex done
writing additional pages... search done
copying images... [ 55%] _build/jupyter_execute/7baf196d9ea191cc9f552705148b505c95bc44bd8d20762b4408
copying images... [ 59%] _build/jupyter_execute/961ccf2d21bb45ddc5a735b657550ebf380b508173891513db90
copying images... [ 82%] _build/jupyter_execute/f52a61a867091a818e1acc164177df0b8e6967c73e2babf6f81b
copying images... [ 86%] _build/jupyter_execute/a749e8885585ee2b150f28fa622ef6efde3ceab91bbee2248dce
copying images... [ 91%] _build/jupyter_execute/381ba5fd7b53f739dbd688ee9bdd9b240d6bbac4293e45be4129
copying images... [100%] _static/burr_video_thumbnail.jpg
dumping search index in English (code: en)... done
dumping object inventory... done
sphinx-sitemap: sitemap.xml was generated for URL https://burr.staged.apache.org/docs/ in /home/hkpm/git_repos/burr/docs/_build/html/sitemap.xml
build succeeded, 1 warning.

The HTML pages are in _build/html.

@harishkesavarao
Copy link
Copy Markdown
Contributor Author

this needs to be referenced in an index for it to be displayed. can you build the docs locally and show it being surfaced please?

Added the reference and built the docs locally (added screenshots to the description for the build and the ecosystem page being surfaced locally)

@harishkesavarao harishkesavarao requested a review from skrawcz April 2, 2026 18:54
@harishkesavarao
Copy link
Copy Markdown
Contributor Author

@skrawcz when you get a moment, can you please review the PR again?

Copy link
Copy Markdown
Contributor

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

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

thanks!

@skrawcz skrawcz merged commit 8571806 into apache:main Apr 5, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/website burr.apache.org website kind/documentation Docs, examples, notebooks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants