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

Configuration Documentation Enhancement #958

Closed
MarcusSorealheis opened this issue Jun 3, 2024 · 1 comment · Fixed by #970
Closed

Configuration Documentation Enhancement #958

MarcusSorealheis opened this issue Jun 3, 2024 · 1 comment · Fixed by #970

Comments

@MarcusSorealheis
Copy link
Collaborator

Currently we do not document our configuration object sufficiently enough.

We need to accomplish three goals:

  1. Break out each key and explain all the options, with a plan to update after refactoring the configuration object.

In the same way that there are some pages of deployment examples, we need a sub-page for each configuration key so that people can isolate what they need to understand if they choose to. For example, experimental_promtheus should also have its own sub-page explaining how it works.

image
  1. Provide a lot more configuration examples by use case.

In the same way that we Deployment Examples, we should also have Configuration Examples, such that the current Configuration should become Configuration Options.

  1. Include documentation in our docs for Buck2 and Reclient.

We also need a top level page for describing how you can use NativeLink with Buck2 and one for how you can use NativeLink with Reclient. For example, we need to include concepts like injecting cpu_count values for Reclient, as has appeared in the Slack.

@blakehatch
Copy link
Contributor

Hi @MarcusSorealheis will take on the Buck2 portions of this. Will become two issues but will likely get landed around the same time and will reference this issue.

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 a pull request may close this issue.

2 participants