Skip to content

Commit

Permalink
Fix invalid links in the documentation
Browse files Browse the repository at this point in the history
Relative links in markdown files produce 404 error when it's deployed
on the documentation site. Reviewed all relative links in markdown
files and fixed them all. This commit doesn't include any CIs to
prevent from 404 errors permanently ( maybe that's what to do next
from here ), but it's a hotfix for currently not available links in
the documentation website which are actually hurting user experience.
  • Loading branch information
aleksdmladenovic committed Aug 9, 2024
1 parent 7777938 commit 395df95
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 15 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ please raise an issue so that we can clarify this document.
## Local development setup
NativeLink ships almost all of its tooling in a nix flake which is configured
via a [`flake.nix`](./flake.nix) file in the root of the repository. While it's
via a [`flake.nix`](https://github.com/tracemachina/nativelink/tree/master/flake.nix) file in the root of the repository. While it's
possible to work on some parts of the codebase without this environment, it'll
make your life much easier since it lets you reproduce most of CI locally.
Expand Down Expand Up @@ -468,4 +468,4 @@ most automatically generated changelogs provide.
## Conduct

NativeLink Code of Conduct is available in the
[CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file.
[CODE_OF_CONDUCT](https://github.com/tracemachina/nativelink/tree/master/CODE_OF_CONDUCT.md) file.
2 changes: 1 addition & 1 deletion docs/src/content/docs/contribute/nix.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You'll need a recent version of Nix with flakes enabled, for instance installed
via the [next-gen nix installer](https://github.com/NixOS/experimental-nix-installer).

This build doesn't require cloning the repository, but you need to provide a
configuration file, for instance the one at [`https://github.com/TraceMachina/nativelink/blob/main/nativelink-config/examples/basic_cas.json`](./nativelink-config/examples/basic_cas.json).
configuration file, for instance the one at [`https://github.com/TraceMachina/nativelink/blob/main/nativelink-config/examples/basic_cas.json`](https://github.com/tracemachina/nativelink/tree/master/nativelink-config/examples/basic_cas.json).

The following command builds and runs NativeLink in release (optimized) mode:

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/faq/lre.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ custom toolchain configurations. This system aims to be transparent, fully
hermetic, and reproducible across machines with the same system architecture.

For more detailed information about Local Remote Execution (LRE), please
visit our [LRE Documentation](../explanations/lre/).
visit our [LRE Documentation](https://docs.nativelink.com/explanations/lre/).
2 changes: 1 addition & 1 deletion docs/src/content/docs/faq/remote-execution.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ a development team are working in the same environment, reducing the
reducing redundant work and further speeding up the development process.

For more information on how to get started with remote execution in NativeLink,
please refer to our [NativeLink On-Prem Guide](../introduction/on-prem.mdx).
please refer to our [NativeLink On-Prem Guide](https://docs.nativelink.com/introduction/on-prem).

For more detailed information about remote execution, you can visit the below links:
[Bazel Remote Execution Documentation](https://bazel.build/remote/rbe).
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/introduction/contributors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ pagefind: true
Open source is at the heart of NativeLink.
We're always immensely grateful for the contributions from our community!

For more details on how to contribute, please refer to our [Contribution Guide](./guides/contributing.mdx).
For more details on how to contribute, please refer to our [Contribution Guide](https://docs.nativelink.com/contribute/guidelines).

## Have additional questions?

Expand Down
6 changes: 3 additions & 3 deletions local-remote-execution/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ build:lre --extra_toolchains=@local-remote-execution//generated-cc/config:cc-too
```

The `@local-remote-execution` Bazel module contains the Bazel-side configuration
of the LRE toolchain. If you view [`generated-cc/cc/BUILD`](./generated-cc/cc/BUILD)
of the LRE toolchain. If you view [`generated-cc/cc/BUILD`](https://github.com/tracemachina/nativelink/tree/master/local-remote-execution/generated-cc/cc/BUILD)
you should find the same `/nix/store/...` paths as in the `lre.bazelrc` file.

Now import the LRE toolchains in your `MODULE.bazel` to make the
Expand All @@ -192,7 +192,7 @@ Let's use NativeLink's Kubernetes example to verify that the setup worked.
## 🚢 Testing with local K8s

Start the cluster and set up NativeLink in an LRE configuration. For details on
this refer to the [Kubernetes example](../deployment-examples/kubernetes):
this refer to the [Kubernetes example](https://github.com/tracemachina/nativelink/tree/master/deployment-examples/kubernetes):

> [!TIP]
> NativeLink's `native` CLI tool is self-contained and can be imported into
Expand Down Expand Up @@ -345,7 +345,7 @@ Instead, their container environments are used and passed through transforming
functions that take a container schematic as input and generate some other
output.
The first transform is the [`createWorker`](../tools/create-worker.nix) wrapper
The first transform is the [`createWorker`](https://github.com/tracemachina/nativelink/tree/master/tools/create-worker.nix) wrapper
which converts an arbitrary OCI image to a NativeLink worker:
```mermaid
Expand Down
2 changes: 1 addition & 1 deletion nativelink-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

NativeLink uses a JSON file as the configuration format.

To view the available fields please refer to the [configuration reference](../../reference/nativelink-config).
To view the available fields please refer to the [configuration reference](https://github.com/tracemachina/nativelink/tree/master/nativelink-config/src).

## Examples

Expand Down
8 changes: 3 additions & 5 deletions nativelink-scheduler/tests/utils/mock_scheduler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,9 @@ use nativelink_error::{make_input_err, Error};
use nativelink_metric::{MetricsComponent, RootMetricsComponent};
use nativelink_scheduler::action_scheduler::ActionScheduler;
use nativelink_scheduler::platform_property_manager::PlatformPropertyManager;
use nativelink_util::{
action_messages::{ActionInfo, OperationId},
operation_state_manager::{
ActionStateResult, ActionStateResultStream, ClientStateManager, OperationFilter,
},
use nativelink_util::action_messages::{ActionInfo, OperationId};
use nativelink_util::operation_state_manager::{
ActionStateResult, ActionStateResultStream, ClientStateManager, OperationFilter,
};
use tokio::sync::{mpsc, Mutex};

Expand Down

0 comments on commit 395df95

Please sign in to comment.