Skip to content

Conversation

@alexeagle
Copy link
Collaborator

@alexeagle alexeagle commented Sep 22, 2025

Allow a controlled way for content on the site to diverge from bazelbuild/bazel repo.
This relaxes how complete our translation from Jekyll and HTML needs to be. In this example I manually fix a <table> tag, which means we don't have to create an automated replacement.

The size of the patch file makes it obvious whether we are diverging too much, versus a fork of the repo where the git history hides the delta from upstream.

Issues:

  • patches could allow us to present content that isn't Googler-approved
  • the patch might fail to apply later when the upstream changes, so they require ongoing rebasing

@alan707
Copy link
Collaborator

alan707 commented Sep 23, 2025

I think if we go this route, we should make it a first class citizen in the README (and the docs) on how to actually do a patch correctly. I'm not a huge fan of patches because the patches themselves are not human readable. In this case it works becuase the output is human readable: the resulting mdx file.

@alan707
Copy link
Collaborator

alan707 commented Sep 23, 2025

What I mean by human readable is: they are not the easiest thing to grok for the untrained eye.

@alexeagle
Copy link
Collaborator Author

If we allow patches, I imagine the script would actually diff the upstream/ submodule against origin, and update all the patches for you, like https://github.com/ds300/patch-package

But this example with a

isn't a great motivation since it's not that hard to automate this translation. I'm fine not merging this and we can discuss more.

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