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 configuration breakdown page #725

Merged
merged 1 commit into from
Mar 7, 2024

Conversation

blakehatch
Copy link
Member

@blakehatch blakehatch commented Mar 5, 2024

Description

Adds a page to list out all configuration options to aid in customization. Can be viewed by running yarn start in /nativelink-docs folder and going to the Configuration page.

Fixes #724

Type of change

  • This change requires a documentation update

Checklist

  • Updated documentation if needed
  • Tests added/amended
  • bazel test //... passes locally
  • PR is contained in a single commit, using git amend see some docs

This change is Reviewable

Preview Deployment: https://nativelink-docs-git-fork-blakehat-0da362-native-link-web-assets.vercel.app/Configuration

Copy link
Member

@adam-singer adam-singer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to preview this change deployed as a draft before landed?

Reviewable status: 0 of 1 LGTMs obtained

@blakehatch
Copy link
Member Author

Is it possible to preview this change deployed as a draft before landed?

Reviewable status: 0 of 1 LGTMs obtained

https://nativelink-docs-git-fork-blakehat-0da362-native-link-web-assets.vercel.app/Configuration

Sorry I need to remember to link these in the PR for all major documentation changes.

Copy link
Collaborator

@MarcusSorealheis MarcusSorealheis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the link.

In general, it's a big step in the right direction but it's not quite complete enough even for a merge.

At a high level, all i see is a long list of configuration options but it's not clear where they belong in the configuration file. The configuration file is a beat itself and that's the reason for the breakdown.

Now, I would switch to approve if by approving this it means we can do more of the work as a fast follow. I would just be totally overwhelmed by a docs page that says copy this code and these are the options.

Reviewable status: 0 of 1 LGTMs obtained

Copy link
Collaborator

@MarcusSorealheis MarcusSorealheis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 1 LGTMs obtained


nativelink-docs/docs/Configuration.mdx line 149 at r1 (raw file):

    }
    ```
    <!-- vale on -->

lovely. I think it avoids quotes, back ticks, and string literals.


nativelink-docs/docs/Configuration.mdx line 251 at r1 (raw file):

    ### 2. Paste default sample where needed in custom [deployment](https://github.com/blakehatch/nativelink/tree/main/deployment-examples).
    ### 3. Change settings to preferred values.

it's not clear for sure that this is all for a store.

@blakehatch
Copy link
Member Author

Thanks for the link.

In general, it's a big step in the right direction but it's not quite complete enough even for a merge.

At a high level, all i see is a long list of configuration options but it's not clear where they belong in the configuration file. The configuration file is a beat itself and that's the reason for the breakdown.

Now, I would switch to approve if by approving this it means we can do more of the work as a fast follow. I would just be totally overwhelmed by a docs page that says copy this code and these are the options.

Reviewable status: 0 of 1 LGTMs obtained

I agree there needs to be more context to the configuration options. I'll probably section them off with tabs and some examples to provide more context. Then we can make an additional PR improving this further once we have more user feedback.

Copy link
Collaborator

@MarcusSorealheis MarcusSorealheis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm: I said we merge this one and iterate.

Reviewable status: 1 of 1 LGTMs obtained


nativelink-docs/docs/Configuration.mdx line 251 at r1 (raw file):

    ### 2. Paste default sample where needed in custom [deployment](https://github.com/blakehatch/nativelink/tree/main/deployment-examples).
    ### 3. Change settings to preferred values.

it's not clear for sure that this is all for setting up a CAS. It's clear in the sense that the example was here.

Sounds good already cooking up the next steps will open up a new PR asap

Copy link
Member Author

@blakehatch blakehatch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 1 of 1 LGTMs obtained


nativelink-docs/docs/Configuration.mdx line 149 at r1 (raw file):

Previously, MarcusSorealheis (Marcus Eagan) wrote…

lovely. I think it avoids quotes, back ticks, and string literals.

Yes this is really helpful since Vale hates our config and we shouldn't change it for that.


nativelink-docs/docs/Configuration.mdx line 251 at r1 (raw file):

Previously, MarcusSorealheis (Marcus Eagan) wrote…

it's not clear for sure that this is all for a store.

Noted


nativelink-docs/docs/Configuration.mdx line 251 at r1 (raw file):

Previously, MarcusSorealheis (Marcus Eagan) wrote…

it's not clear for sure that this is all for setting up a CAS. It's clear in the sense that the example was here.

It's for setting up both configurations since some customers will not just need CAS, but cas is the default to show up for a reason.

Copy link
Member Author

@blakehatch blakehatch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dismissed @MarcusSorealheis from a discussion.
Reviewable status: 1 of 1 LGTMs obtained

@MarcusSorealheis
Copy link
Collaborator

I think we should try to break the tabs out. The long list of configs is basically unintelligible because of information overload. It's like the importance of section headings in a textbook.

Copy link
Member Author

@blakehatch blakehatch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes broke them out for this version so the info is more digestible. Will iterate on this though

Reviewable status: 1 of 1 LGTMs obtained, and pending CI: Bazel Dev / ubuntu-22.04, Cargo Dev / macos-13, Cargo Dev / ubuntu-22.04, asan / ubuntu-22.04, docker-compose-compiles-nativelink (20.04), docker-compose-compiles-nativelink (22.04), macos-13, ubuntu-20.04 / stable, ubuntu-22.04 / stable, windows-2022 / stable

Copy link
Member Author

@blakehatch blakehatch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dismissed @MarcusSorealheis from a discussion.
Reviewable status: 1 of 1 LGTMs obtained, and pending CI: Bazel Dev / ubuntu-22.04, Cargo Dev / macos-13, Cargo Dev / ubuntu-22.04, asan / ubuntu-22.04, docker-compose-compiles-nativelink (20.04), docker-compose-compiles-nativelink (22.04), macos-13, ubuntu-20.04 / stable, ubuntu-22.04 / stable, windows-2022 / stable

@blakehatch blakehatch marked this pull request as ready for review March 7, 2024 06:17
@blakehatch blakehatch merged commit 35daf43 into TraceMachina:main Mar 7, 2024
25 checks passed
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.

Add Configuration Field Breakdown in nativelink-docs
3 participants