Skip to content

Commit

Permalink
Fix format issues in markdown files (#1332)
Browse files Browse the repository at this point in the history
Currently, when Markdown Linting is run, there are some minor format
issues in markdown files. Checked all markdown files and fixed
all relevant issues in them.
  • Loading branch information
aleksdmladenovic authored Sep 7, 2024
1 parent f533d30 commit 0ab5a99
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 7 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ please raise an issue so that we can clarify this document.

> [!WARNING]
> Don't use
>
> ```bash
> git clone [email protected]:TraceMachina/nativelink
> ```
Expand Down Expand Up @@ -199,23 +200,22 @@ NativeLink doesn't allow direct commits or human-created side branches in the
git push --set-upstream origin some-feature
```

6. Go to https://github.com/TraceMachina/nativelink/pulls where you should see a
5. Go to https://github.com/TraceMachina/nativelink/pulls where you should see a
button that you can click to create to create a new pull request from your
fork to the main repository.

7. Once you opened the pull request, click on the purple `Reviewable` button in
6. Once you opened the pull request, click on the purple `Reviewable` button in
the GitHub page for the pull request to add reviewers with `+@somereviewer`.

The reviewers will take it from there and guide you through any potential
remaining issues. Feel free to ask for help if you have trouble getting CI
for your pull request green.

8. If you need to make additional changes, don't use a regular `git commit` on
7. If you need to make additional changes, don't use a regular `git commit` on
the pull request branch. Instead use `git commit --amend` and `git push -f`
to update the commit in-place. The changes between the commit versions will
remain visible in the Reviewable UI.


### Using `git rebase`

When you start working on a feature your `git log` looks something like this:
Expand Down Expand Up @@ -394,7 +394,7 @@ NativeLink implements its documentation style guide via Vale. The pre-commit
hooks forbid errors but permit warnings and suggestions. To view all of Vale's
suggestions invoke it directly:

```
```bash
vale somefile
```

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ it via the [next-gen nix installer](https://github.com/NixOS/experimental-nix-in
**Linux, MacOS, WSL2**

```
```bash
curl -O \
https://raw.githubusercontent.com/TraceMachina/nativelink/main/nativelink-config/examples/basic_cas.json

Expand Down
3 changes: 3 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,21 @@ corresponds to the `main` branch. Images are signed by the GitHub action that
produced the image. Note that the [OCI workflow](https://github.com/TraceMachina/nativelink/actions/workflows/image.yaml) might take a few minutes to publish the latest image.

### Get the tag for the latest commit

```sh
export LATEST=$(nix eval github:TraceMachina/nativelink#image.imageTag --raw)
```

### Verify the signature

```sh
cosign verify ghcr.io/tracemachina/nativelink:${LATEST} \
--certificate-identity=https://github.com/TraceMachina/nativelink/.github/workflows/image.yaml@refs/heads/main \
--certificate-oidc-issuer=https://token.actions.githubusercontent.com
```

### Get the Tag for a Specific Commit

For use in production pin the image to a specific revision:

```sh
Expand Down
4 changes: 4 additions & 0 deletions deployment-examples/chromium/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ This deployment sets up a 4-container deployment with separate CAS, scheduler
and worker. Don't use this example deployment in production. It's insecure.

> [!WARNING]
>
> - The client build request is best done from a Ubuntu image, `./03_build_chrome_tests.sh`. It will check if the image is Ubuntu and
> fail otherwise.
> - This tutorial has been tested in a Nix environment of version `2.
Expand Down Expand Up @@ -75,6 +76,7 @@ in [linux/build_instructions.md](https://chromium.googlesource.com/chromium/src/

> [!TIP]
> You can monitor the logs of container groups with `kubectl logs`:
>
> ```bash
> kubectl logs -f -l app=nativelink-cas
> kubectl logs -f -l app=nativelink-scheduler
Expand All @@ -87,5 +89,7 @@ When you're done testing, delete the cluster:
```bash
kind delete cluster
```
## NativeLink Community
If you have any questions, please reach out to the [NativeLink Community](https://join.slack.com/t/nativelink/shared_invite/zt-2i2mipfr5-lZAEeWYEy4Eru94b3IOcdg).
5 changes: 5 additions & 0 deletions deployment-examples/kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ bazel build \
> You can add these flags to a to a `user.bazelrc` file in the workspace root.
> Note that you'll need to pass in explicit IP addresses as this file can't
> resolve environment variables:
>
> ```bash
> # user.bazelrc
> build --config=lre
Expand Down Expand Up @@ -115,14 +116,17 @@ git log
git checkout commitHash
nix eval .#image.imageTag --raw
```
The `--raw` removes the surrounding quotes from the output string.

> [!WARNING]
> We don't recommend using this command to
> retrieve an image:
>
> ```sh
> nix eval github:TraceMachina/nativelink#image.imageTag --raw
> ```
>
> Using this command prevents anyone from
> identifying the specific version of the
> NativeLink container in use because
Expand All @@ -136,6 +140,7 @@ The `--raw` removes the surrounding quotes from the output string.
## Build and copy an OCI image
You can build and copy the image to a container registry with the `copyTo` attribute. Below are examples within the NativeLink repository for building and copying an image:
- [Example 1](https://github.com/TraceMachina/nativelink/blob/09b32c94d3cc7780816585e9b87f69c56cf931ae/deployment-examples/kubernetes/01_operations.sh#L12-L16) highlights:
```sh
Expand Down
2 changes: 1 addition & 1 deletion local-remote-execution/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ perfect cache hit rate across different repositories, developers, and CI.
> [!NOTE]
> At the moment LRE only works on `x86_64-linux`.
## Pre-Requisites
## Pre-Requisites

- Nix 2.19.0 or later
- A functional local container setup
Expand Down

0 comments on commit 0ab5a99

Please sign in to comment.