OpenLineage Website

All content for this Docusaurus site can be found in website/. Contributions are welcome in the form of issues or pull requests.

New posts

We love new blog posts and welcome content about OpenLineage! Good topics include:

• experiences from users of all kinds
• supporting products and technologies
• proposals for discussion.

If you are familiar with the GitHub pull request process, proposing a new blog post is easy:

1. Fork this project.
2. Make a new directory in website/blog.
3. Add your author information -- name, title, url (optional), image_url (optional) -- to blog/authors.yml.
4. Create an index.mdx file in the new directory containing your blog. The title, date, authors, and description front matter fields are required. For the authors field, put the author name you added to authors.yml in an array ([Doe]). Please add any images to the new directory. Recommended: use one of the other posts as a template.
5. Run the site locally to test it (recommended).
6. Commit your changes and open a pull request.

New ecosystem partners for the Ecosystem page

1. Fork this project.
2. Add a rectangular logo in SVG format with the dimensions 300px x 150px to static/img.
3. Add a record to the appropriate file and array in static/ecosystem, using the filename of the logo for the image value, like so:

  {
    image: "select_star_logo.png",
    org: "Select Star",
    full_name: "Select Star",
    description:
      "Select Star uses OpenLineage events to extract and generate column-level lineage, enabling precise metadata tracking, impact analysis, and comprehensive documentation of data pipelines.",
    docs_url: "https://docs.selectstar.com/",
    org_url: "https://www.selectstar.com/",
  },

4. Run the site locally to test it (strongly recommended).
5. Commit your changes and open a pull request.

New talks for the Community page

1. Fork this project.
2. Add a talk photo or screenshot in PNG format with the dimensions 1920 x 1080 px to static/img.
3. Add an array to static/talks/talkStrings.tsx, using the filename of the photo for the image value. Note that the video_url is optional:

  {
    conf: "Iceberg Summit 2025",
    date: "2025-04-09",
    image: "iceberg_summit_2025.png",
    title: "Operationalizing Iceberg Metrics with OpenLineage",
    speakers: ["Paweł Leszczyński"],
    description:
      "Recent efforts by the OpenLineage community have enriched lineage metadata with Iceberg’s scan and commit reports, which provides beneficial insights on data read and written. This knowledge can be applied for optimizing costs, as it enables the identification of jobs with the highest cost reduction potential. In this talk, we introduce OpenLineage to the Iceberg community and present the community's efforts to include Iceberg’s scan and commit reports within the lineage metadata collected.",
    video_url: "https://www.youtube.com/watch?v=7mXbe_XCFdA",
    conf_url: "https://www.icebergsummit2025.com",
  },

4. Run the site locally to test it (recommended).
5. Commit your changes and open a pull request.

New meetup groups for the Community page

1. Fork this project.
2. Add a meetup photo or screenshot in PNG format with the dimensions 1920 x 1080 px to static/img.
3. Add an array to static/meetups/meetupStrings.tsx, using the filename of the photo for the image value, like so:

  {
    image: "toronto_screen.png",
    city: "Toronto",
    link: "https://www.meetup.com/openlineage/",
  },

4. Run the site locally to test it (recommended).
5. Commit your changes and open a pull request.

Changes to other landing pages

If you want to make a change to one of the other landing pages -- e.g., to add a resource to the Resources page -- the best way is to submit a pull request.

These Markdown pages can be found in src/pages.

Building OpenAPI docs

To build the OpenAPI docs using redoc-cli, run:

% yarn run build:docs

Local testing

Important

Requires Node (>=18.0) and Yarn.

First, clone the repo and change into the website directory:

$ git clone [email protected]:OpenLineage/OpenLineage.git && cd website

Next, install the Node dependencies for the project using Yarn:

$ yarn

Local site build (optional)

If desired, build the docs locally:

$ yarn build

This command generates static content into the build directory. If you want to look at it, run:

$ cd build && python3 -m http.server

Local server start

Tell Yarn to start a development server:

$ yarn start

The server uses port 3000 by default. If the port is already allocated, you can specify a different one:

$ yarn start --port 3001

Deployment

Each merged change to code in this directory triggers a GitHub Workflow that publishes a new version of the site via the openlineage-site worker repo, which enables automated versioning of the docs. Unless changes to older docs versions are desired, all changes to the site and docs should be made here. Additional content is published by the compatibility-tests repo.