Skip to content

Adds github and asf workflow for docs and adds headers to files#577

Merged
skrawcz merged 10 commits intomainfrom
stefan/docs
Oct 3, 2025
Merged

Adds github and asf workflow for docs and adds headers to files#577
skrawcz merged 10 commits intomainfrom
stefan/docs

Conversation

@skrawcz
Copy link
Contributor

@skrawcz skrawcz commented Sep 8, 2025

See this PR -> https://burr.staged.apache.org/

To publish docs we need to publish via
the ASF preferred mechanism. This hopefully
sets things up.

Adds headers to fall files.
Changes references where needed. E.g. Burr -> Apache Burr; updates domains.

Changes

  • adds to .asf
  • adds to .github workflows
  • updates docs & references.
  • adds headers to all files

How I tested this

  • via this PR

Notes

TODO:

  • update base URL
  • add ASF footer
  • add ASF links
  • update docs for ASF guidelines -- e.g. Apache Burr vs Burr
  • remove / fix video on front page due to not allowing images from other

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.

@github-actions
Copy link

github-actions bot commented Sep 8, 2025

A preview of 9fd63c4 is uploaded and can be seen here:

https://burr.dagworks.io/pull/577

Changes may take a few minutes to propagate. Since this is a preview of production, content with draft: true will not be rendered. The source is here: https://github.com/apache/burr/tree/gh-pages/pull/577/

To publish docs we need to publish via
the ASF preferred mechanism. This hopefully
sets things up.
Changes where I could easily search and replace.
Adds footer for ASF stuff.
Changes Burr -> Apache Burr.
Adds license headers to all files.
@skrawcz skrawcz marked this pull request as ready for review September 29, 2025 05:20
@skrawcz skrawcz changed the title Adds github and asf workflow for docs Adds github and asf workflow for docs and adds headers to files Sep 29, 2025
@skrawcz skrawcz requested a review from pjfanning October 1, 2025 05:47
@skrawcz skrawcz merged commit d38bcc3 into main Oct 3, 2025
2 checks passed
@skrawcz skrawcz deleted the stefan/docs branch October 3, 2025 05:17
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.

3 participants