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

Fix the incorrect config path in the documentation #416

Merged
merged 1 commit into from
Nov 24, 2023

Conversation

steedmicro
Copy link
Contributor

@steedmicro steedmicro commented Nov 23, 2023

Description

After the rewrite of the build infrastructure, all path problems are resolved successfully in code files.
But we missed some of them in the documentation.

Updating documentation needs to be done since it needs to be read by users.
Those documentation issues are fixed.

Fixes #415

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

Please also list any relevant details for your test configuration

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

Copy link
Member

@allada allada left a comment

Choose a reason for hiding this comment

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

Reviewed 2 of 4 files at r1.
Reviewable status: 2 of 4 files reviewed, 2 unresolved discussions (waiting on @steed924)


proto/com/github/trace_machina/native_link/remote_execution/worker_api.proto line 88 at r1 (raw file):

    ///
    /// The details on how to use this property can be found here:
    /// https://github.com/tracemachina/native-link/blob/master/native-link-config/src/cas_server.rs

nit: We need to pin the hash or else the code can change and make this comment link not work.


proto/genproto/com.github.trace_machina.native_link.remote_execution.pb.rs line 45 at r1 (raw file):

    /// /
    /// / The details on how to use this property can be found here:
    /// / <https://github.com/tracemachina/native-link/blob/master/native-link-config/src/cas_server.rs>

ditto.

Copy link
Contributor Author

@steedmicro steedmicro 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: 2 of 4 files reviewed, 1 unresolved discussion (waiting on @allada)


proto/com/github/trace_machina/native_link/remote_execution/worker_api.proto line 88 at r1 (raw file):

Previously, allada (Nathan (Blaise) Bruer) wrote…

nit: We need to pin the hash or else the code can change and make this comment link not work.

done


proto/genproto/com.github.trace_machina.native_link.remote_execution.pb.rs line 45 at r1 (raw file):

Previously, allada (Nathan (Blaise) Bruer) wrote…

ditto.

done

Copy link
Member

@aaronmondal aaronmondal left a comment

Choose a reason for hiding this comment

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

Reviewed 2 of 2 files at r2, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @allada)

Copy link
Member

@aaronmondal aaronmondal 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 catching these!

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @allada)

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 wonder if we should one day maintain a jsonc file that is a copy of all the json files. That way, we dan have one representation that is comment compatible so that our users do not need to edit the JSON but can still understand the reference jsonc's.

Copy link
Member

@allada allada left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 2 of 2 files at r2, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @steed924)

@allada allada merged commit 7f40696 into TraceMachina:main Nov 24, 2023
15 checks passed
TripleKai pushed a commit to TripleKai/turbo-cache that referenced this pull request Nov 29, 2023
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.

Fix the incorrect config path in the documentation
4 participants