Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for modifiers #848

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cbarrete
Copy link
Contributor

@cbarrete cbarrete commented Jan 20, 2025

cc @cjhopman since you wrote the original RFC :)
Let me know if something is inaccurate.

Related to #846

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jan 20, 2025
@facebook-github-bot
Copy link
Contributor

@facebook-github-bot has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. (Because this pull request was imported automatically, there will not be any future comments.)

@scottcao
Copy link
Contributor

Thanks for doing this. This is a good starting point. I will take this and polish it a bit.

Note the original RFC I wrote has been moved from markdown file to google doc because it's much faster to iterate. However, a pdf copy of it still lives in the repo: https://github.com/facebook/buck2/blob/main/docs/rfcs/cfg-modifiers/modifiers.pdf. The google doc is available for view as well but you do need to request permission to see it.

@scottcao
Copy link
Contributor

The google doc I was referring to lives in https://docs.google.com/document/d/1yfb2mwnsphGiz9FhftkIGwMorK8is1qq3f_gYOEmkMA/.

@cbarrete
Copy link
Contributor Author

Thanks for doing this. This is a good starting point. I will take this and polish it a bit.

Thanks! I'm happy to get the ball rolling on a bunch of documentation subjects, e.g.:

I have a decent intuition for those, but nothing that would necessarily be completely technically correct. Given a few pointers I wouldn't mind opening a PR, even if it needs some tweaking from someone at Meta.

Regarding the RFC, I actually linked it in the "More information" section of the main page. It was quite useful for me to get started with modifiers, but:

  • It's not currently exposed on https://buck2.build/docs
  • It's not clear to casual readers how up to/out of date the rendered PDF is

@scottcao
Copy link
Contributor

Yeah the fact the pdf is not available on the website is an issue. I will make a note to look into it. The pdf is reasonably up to date but I will publish a new version of it shortly.

I have a decent intuition for those, but nothing that would necessarily be completely technically correct. Given a few pointers I wouldn't mind opening a PR, even if it needs some tweaking from someone at Meta.

I think this would be great. Happy to assist here with pointers or tweaking the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants