Skip to content

Commit

Permalink
docs: add missing $ sign before shell commands in the install guide
Browse files Browse the repository at this point in the history
In the following example screenshot from docs, the missing dollar sign could mislead someone into thinking these are a single command. I have added the missing dollar sign to better individualize each command and for better readability of the install guide.

![image](https://github.com/user-attachments/assets/e2366b34-0a27-4783-9f4c-8aa73b0a5adb)

Closes #23054.

PiperOrigin-RevId: 655465526
Change-Id: I098b9ff268ce5fa4c637c373db297c752c9462a7
  • Loading branch information
taimoorzaeem authored and copybara-github committed Jul 24, 2024
1 parent d5a73cd commit 94d2b3e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions site/en/install/os-x.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ Run the Bazel installer as follows:

```posix-terminal
chmod +x "bazel-{{ '<var>' }}$BAZEL_VERSION{{ '</var>' }}-installer-darwin-x86_64.sh"
./bazel-{{ '<var>' }}$BAZEL_VERSION{{ '</var>' }}-installer-darwin-x86_64.sh --user
```

Expand Down
4 changes: 4 additions & 0 deletions site/en/install/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,11 @@ Bazel comes with two completion scripts. After installing Bazel, you can:

```posix-terminal
sudo apt install apt-transport-https curl gnupg -y
curl -fsSL https://bazel.build/bazel-release.pub.gpg | gpg --dearmor >bazel-archive-keyring.gpg
sudo mv bazel-archive-keyring.gpg /usr/share/keyrings
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/bazel-archive-keyring.gpg] https://storage.googleapis.com/bazel-apt stable jdk1.8" | sudo tee /etc/apt/sources.list.d/bazel.list
```

Expand Down Expand Up @@ -81,6 +84,7 @@ Optionally, you can set `bazel` to a specific version by creating a symlink:

```posix-terminal
sudo ln -s /usr/bin/bazel-1.0.0 /usr/bin/bazel
bazel --version # 1.0.0
```

Expand Down

0 comments on commit 94d2b3e

Please sign in to comment.