Skip to content

Commit

Permalink
Fix the incorrect config path in the documentation (#416)
Browse files Browse the repository at this point in the history
  • Loading branch information
steedmicro authored Nov 24, 2023
1 parent 06654e6 commit 7f40696
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# --release causes link-time-optmization to be enabled, which can take a while
# to compile, but will result in a much faster binary.
cargo run --release --bin cas -- ./config/examples/basic_cas.json
cargo run --release --bin cas -- ./native-link-config/examples/basic_cas.json
```
In a separate terminal session, run the following command to connect the running server launched above to Bazel or another RBE client:
```sh
Expand All @@ -45,7 +45,7 @@ bazel test //... \
--remote_executor=grpc://127.0.0.1:50051 \
--remote_default_exec_properties=cpu_count=1
```
This will cause bazel to run the commands through an all-in-one `CAS`, `scheduler` and `worker`. See [here](https://github.com/tracemachina/native-link/tree/master/config) for configuration documentation and [here](https://github.com/tracemachina/native-link/tree/main/deployment-examples/terraform) for an example of multi-node cloud deployment example.
This will cause bazel to run the commands through an all-in-one `CAS`, `scheduler` and `worker`. See [here](https://github.com/tracemachina/native-link/tree/master/native-link-config) for configuration documentation and [here](https://github.com/tracemachina/native-link/tree/main/deployment-examples/terraform) for an example of multi-node cloud deployment example.

## Example Deployments
We currently have a few example deployments in [deployment-examples directory](https://github.com/tracemachina/native-link/tree/master/deployment-examples).
Expand Down Expand Up @@ -107,7 +107,7 @@ cargo build --release
### Configure

Configuration is done via a JSON file that is passed in as the first parameter to the `cas` program. See [here](https://github.com/tracemachina/native-link/tree/master/config) for more details and examples.
Configuration is done via a JSON file that is passed in as the first parameter to the `cas` program. See [here](https://github.com/tracemachina/native-link/tree/master/native-link-config) for more details and examples.

## How to update internal or external rust deps

Expand Down
4 changes: 2 additions & 2 deletions native-link-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
This service uses a JSON file as the configuration format. The JSON format is
compatible with how protobuf's JSON format is structed.

To view the available fields please refer to [stores.rs](https://github.com/tracemachina/native-link/blob/master/config/stores.rs) and [cas_server](https://github.com/tracemachina/native-link/blob/master/config/cas_server.rs).
To view the available fields please refer to [stores.rs](https://github.com/tracemachina/native-link/blob/master/native-link-config/stores.rs) and [cas_server](https://github.com/tracemachina/native-link/blob/master/native-link-config/cas_server.rs).

These two files should have enough documentation in them on what each field does
and where each field goes.

## Examples

The [examples directory](https://github.com/tracemachina/native-link/tree/master/config/examples) contains a few examples of configuration files.
The [examples directory](https://github.com/tracemachina/native-link/tree/master/native-link-config/examples) contains a few examples of configuration files.

A very basic configuration that is a pure in-memory store is:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ message SupportedProperties {
/// the unsupported properties.
///
/// The details on how to use this property can be found here:
/// https://github.com/tracemachina/native-link/blob/c91f61edf182f2b64451fd48a5e63fa506a43aae/config/cas_server.rs
/// https://github.com/TraceMachina/native-link/blob/3147265047544572e3483c985e4aab0f9fdded38/native-link-config/src/cas_server.rs
repeated build.bazel.remote.execution.v2.Platform.Property properties = 1;
reserved 2; // NextId.
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ pub struct SupportedProperties {
/// / the unsupported properties.
/// /
/// / The details on how to use this property can be found here:
/// / <https://github.com/tracemachina/native-link/blob/c91f61edf182f2b64451fd48a5e63fa506a43aae/config/cas_server.rs>
/// / <https://github.com/TraceMachina/native-link/blob/3147265047544572e3483c985e4aab0f9fdded38/native-link-config/src/cas_server.rs>
#[prost(message, repeated, tag = "1")]
pub properties: ::prost::alloc::vec::Vec<
super::super::super::super::super::build::bazel::remote::execution::v2::platform::Property,
Expand Down

0 comments on commit 7f40696

Please sign in to comment.