Skip to content

Commit 86ac62c

Browse files
Merge pull request #1580 from annietllnd/pr-test-framework
Clean up _index.md files
2 parents 5039f2a + d2c9495 commit 86ac62c

File tree

46 files changed

+590
-487
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+590
-487
lines changed

.github/workflows/test-lp.yml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,22 @@ jobs:
1414
hugo
1515
- name: Get all changed markdown files
1616
id: changed-markdown-files
17-
uses: step-security/changed-files@v45
17+
uses: tj-actions/changed-files@v46
1818
with:
1919
files: |
2020
**.md
21+
- name: Check for capital letters or spaces in content directory
22+
run: |
23+
echo "Checking for capital letters or spaces in content directory paths..."
24+
25+
git diff --name-only origin/${{ github.base_ref }}...HEAD |
26+
grep '^content/' |
27+
grep -E '[A-Z]|[[:space:]]' && {
28+
echo "❌ Found invalid file or directory names with capital letters or spaces in 'content/'"
29+
exit 1
30+
}
31+
32+
echo "✅ No capital letters or spaces found in 'content/' paths."
2133
- name: Install dependencies
2234
if: steps.changed-markdown-files.outputs.any_changed == 'true'
2335
run: pip install -r tools/requirements.txt
@@ -26,7 +38,7 @@ jobs:
2638
if: steps.changed-markdown-files.outputs.any_changed == 'true'
2739
# Run the test suite
2840
run: |
29-
set -o pipefail; ./tools/test_lp.sh ${{ steps.changed-markdown-files.outputs.all_changed_files }} 2>&1 | tee test-lp-output.txt
41+
set -o pipefail; ./tools/test_lp.sh ${{ steps.changed-markdown-files.outputs.all_changed_files }} 2>&1 | tee test-lp-output.txt
3042
- name: Parse test suite errors
3143
id: test-suite-state
3244
if: success()

content/install-guides/acfl.md

Lines changed: 54 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ test_images:
1616
- fedora:latest
1717
test_link: null
1818
test_maintenance: true
19-
test_status:
20-
- passed
21-
- passed
2219
title: Arm Compiler for Linux
2320
tool_install: true
2421
weight: 1
@@ -89,7 +86,7 @@ bash <(curl -L https://developer.arm.com/-/cdn-downloads/permalink/Arm-Compiler-
8986

9087
Download releases from the command line using `wget`. Install `wget` if not present.
9188

92-
```console
89+
```bash
9390
sudo apt install wget
9491
```
9592

@@ -117,7 +114,7 @@ Each command sequence includes accepting the license agreement to automate the i
117114

118115
#### Ubuntu Linux:
119116

120-
```bash { target="ubuntu:latest", env="DEBIAN_FRONTEND=noninteractive" }
117+
```bash { target="ubuntu:latest" }
121118
sudo -E apt-get -y install environment-modules python3 libc6-dev
122119
tar -xvf arm-compiler-for-linux_24.10.1_Ubuntu-22.04_aarch64.tar
123120
cd ./arm-compiler-for-linux_24.10.1_Ubuntu-22.04
@@ -126,10 +123,10 @@ sudo ./arm-compiler-for-linux_24.10.1_Ubuntu-22.04.sh --accept
126123

127124
#### Red Hat Linux:
128125

129-
```bash { target="fedora:latest" }
126+
```console
130127
sudo yum -y install environment-modules python3 glibc-devel
131128
tar -xvf arm-compiler-for-linux_24.10.1_RHEL-9_aarch64.tar
132-
cd arm-compiler-for-linux_24.10.1_RHEL-9
129+
cd ./arm-compiler-for-linux_24.10.1_RHEL-9
133130
sudo ./arm-compiler-for-linux_24.10.1_RHEL-9.sh --accept
134131
```
135132

@@ -150,25 +147,23 @@ Arm Compiler for Linux is available to install with the Ubuntu system package ma
150147

151148
#### Set up the ACfL package repository
152149

153-
Add the ACfL `apt` package repository to your Ubuntu 20.04 or 22.04 system:
150+
Add the ACfL `apt` package repository to your system. These instructions apply for Ubuntu 22.04. You can check the [available versions](https://developer.arm.com/packages/) for other releases.
154151

155-
```bash { target="ubuntu:latest" }
152+
After that, the ACfL Ubuntu package repository is now ready to use. Run the commands below to install the dependencies needed.
153+
154+
155+
```console
156156
sudo apt update
157-
sudo apt install -y curl environment-modules python3 libc6-dev
158-
. /etc/os-release
159-
curl "https://developer.arm.com/packages/ACfL%3A${NAME}-${VERSION_ID/%.*/}/${VERSION_CODENAME}/Release.key" | sudo tee /etc/apt/trusted.gpg.d/developer-arm-com.asc
160-
echo "deb https://developer.arm.com/packages/ACfL%3A${NAME}-${VERSION_ID/%.*/}/${VERSION_CODENAME}/ ./" | sudo tee /etc/apt/sources.list.d/developer-arm-com.list
157+
sudo apt install -y wget gnupg gpg environment-modules python3 libc6-dev
158+
wget -qO - https://developer.arm.com/packages/ACfL%3AUbuntu-22/jammy/Release.key | sudo tee /etc/apt/trusted.gpg.d/developer-arm-com.asc
159+
echo "deb https://developer.arm.com/packages/ACfL%3AUbuntu-22/jammy/ ./" | sudo tee /etc/apt/sources.list.d/developer-arm-com.list
161160
sudo apt update
162161
```
163162

164-
The ACfL Ubuntu package repository is now ready to use.
163+
Install Arm Compiler for Linux with:
165164

166-
#### Install ACfL
167-
168-
Download and install Arm Compiler for Linux with:
169-
170-
```bash { target="ubuntu:latest" }
171-
sudo apt install acfl
165+
```console
166+
sudo apt install acfl -y
172167
```
173168

174169
### Amazon Linux 2023
@@ -179,46 +174,46 @@ Arm Compiler for Linux is available to install with either the `dnf` or `yum` sy
179174

180175
Install ACfL and prerequisites from the Amazon Linux 2023 `rpm` package repository with `dnf`:
181176

182-
```bash
183-
sudo dnf update
184-
sudo dnf install 'dnf-command(config-manager)' procps psmisc make environment-modules
185-
sudo dnf config-manager --add-repo https://developer.arm.com/packages/ACfL%3AAmazonLinux-2023/latest/ACfL%3AAmazonLinux-2023.repo
186-
sudo dnf install acfl
177+
```console
178+
sudo dnf update -y
179+
sudo dnf -y install 'dnf-command(config-manager)' procps psmisc make environment-modules
180+
sudo dnf config-manager addrepo --from-repofile=https://developer.arm.com/packages/ACfL%3AAmazonLinux-2023/latest/ACfL%3AAmazonLinux-2023.repo
181+
sudo dnf -y install acfl
187182
```
188183

189184
Or using the equivalent `yum` commands:
190185

191-
```bash
192-
sudo yum update
193-
sudo yum install 'dnf-command(config-manager)' procps psmisc make environment-modules
194-
sudo yum config-manager --add-repo https://developer.arm.com/packages/ACfL%3AAmazonLinux-2023/latest/ACfL%3AAmazonLinux-2023.repo
195-
sudo yum install acfl
186+
```console
187+
sudo yum update -y
188+
sudo yum -y install 'dnf-command(config-manager)' procps psmisc make environment-modules
189+
sudo yum config-manager addrepo --from-repofile=https://developer.arm.com/packages/ACfL%3AAmazonLinux-2023/latest/ACfL%3AAmazonLinux-2023.repo
190+
sudo yum -y install acfl
196191
```
197192

198193
The ACfL tools are now ready to use.
199194

200-
### Red Hat Enterprise Linux (RHEL) 9
195+
### Red Hat Enterprise Linux (RHEL) 9
201196

202197
Arm Compiler for Linux is available to install with either the `dnf` or `yum` system package manager.
203198

204199
#### Install ACfL from the RHEL 9 package repository
205200

206201
Install ACfL and prerequisites from the RHEL 9 `rpm` package repository with `dnf`:
207202

208-
```bash
209-
sudo dnf update
210-
sudo dnf install 'dnf-command(config-manager)' procps psmisc make environment-modules
211-
sudo dnf config-manager --add-repo https://developer.arm.com/packages/ACfL%3ARHEL-9/standard/ACfL%3ARHEL-9.repo
212-
sudo dnf install acfl
203+
```console
204+
sudo dnf update -y
205+
sudo dnf -y install 'dnf-command(config-manager)' procps psmisc make environment-modules
206+
sudo dnf config-manager addrepo --from-repofile=https://developer.arm.com/packages/ACfL%3ARHEL-9/standard/ACfL%3ARHEL-9.repo
207+
sudo dnf -y install acfl
213208
```
214209

215210
Or using the equivalent `yum` commands:
216211

217-
```bash
218-
sudo yum update
219-
sudo yum install 'dnf-command(config-manager)' procps psmisc make environment-modules
220-
sudo yum config-manager --add-repo https://developer.arm.com/packages/ACfL%3ARHEL-9/standard/ACfL%3ARHEL-9.repo
221-
sudo yum install acfl
212+
```console
213+
sudo yum update -y
214+
sudo yum -y install 'dnf-command(config-manager)' procps psmisc make environment-modules
215+
sudo yum config-manager addrepo --from-repofile=https://developer.arm.com/packages/ACfL%3ARHEL-9/standard/ACfL%3ARHEL-9.repo
216+
sudo yum -y install acfl
222217
```
223218

224219
The ACfL tools are now ready to use.
@@ -227,39 +222,35 @@ The ACfL tools are now ready to use.
227222

228223
Arm Compiler for Linux uses environment modules to dynamically modify your user environment. Refer to the [Environment Modules documentation](https://lmod.readthedocs.io/en/latest/#id) for more information.
229224

230-
Set up the environment, for example, in your `.bashrc` and add module files.
225+
Set up the environment, for example, in your `.bashrc` and add module files. Then, list the available modules:
231226

232227
#### Ubuntu Linux:
233228

234-
```bash { target="ubuntu:latest" }
235-
echo ". /usr/share/modules/init/bash" >> ~/.bashrc
236-
echo "module use /opt/arm/modulefiles" >> ~/.bashrc
237-
. ~/.bashrc
229+
```bash { target="ubuntu:latest" pre_cmd=". /usr/share/modules/init/bash" pre_cmd="module use /opt/arm/modulefiles" }
230+
echo ". /usr/share/modules/init/bash" >> $HOME/.bashrc
231+
echo "module use /opt/arm/modulefiles" >> $HOME/.bashrc
232+
source $HOME/.bashrc
233+
module avail
238234
```
239235

240236
#### Red Hat or Amazon Linux:
241237

242-
```bash { target="fedora:latest" }
243-
echo ". /usr/share/Modules/init/bash" >> ~/.bashrc
244-
echo "module use /opt/arm/modulefiles" >> ~/.bashrc
245-
. ~/.bashrc
246-
```
247-
248-
To list available modules:
249-
250-
```bash { env_source="~/.bashrc" }
238+
```console
239+
echo ". /usr/share/Modules/init/bash" >> $HOME/.bashrc
240+
echo "module use /opt/arm/modulefiles" >> $HOME/.bashrc
241+
source $HOME/.bashrc
251242
module avail
252243
```
253244

254245
To configure Arm Compiler for Linux:
255246

256-
```bash { env_source="~/.bashrc" }
247+
```console
257248
module load acfl/24.10.1
258249
```
259250

260251
To configure GCC:
261252

262-
```bash { env_source="~/.bashrc" }
253+
```console
263254
module load gnu/14.2.0
264255
```
265256

@@ -318,7 +309,7 @@ ACfL is now [ready to use](#armclang).
318309
To get started with the Arm C/C++ Compiler and compile a simple application follow the steps below.
319310

320311
Check that the correct compiler version is being used:
321-
```bash { env_source="~/.bashrc", pre_cmd="module load acfl/24.10.1" }
312+
```bash { env_source="$HOME/.bashrc", pre_cmd=". /usr/share/modules/init/bash; module use /opt/arm/modulefiles; module load acfl/24.10.1" }
322313
armclang --version
323314
```
324315

@@ -336,13 +327,13 @@ int main()
336327

337328
Build the application with:
338329

339-
```console { env_source="~/.bashrc", pre_cmd="module load acfl/24.10.1" }
330+
```console
340331
armclang hello.c -o hello
341332
```
342333

343334
Run the application with:
344335

345-
```bash { env_source="~/.bashrc", pre_cmd="module load acfl/24.10.1" }
336+
```console
346337
./hello
347338
```
348339

@@ -356,7 +347,7 @@ Hello, C World!
356347
To get started with the Arm Fortran Compiler and compile a simple application follow the steps below.
357348

358349
Check that the correct compiler version is being used:
359-
```bash { env_source="~/.bashrc", pre_cmd="module load acfl/24.10.1" }
350+
```bash { env_source="$HOME/.bashrc", pre_cmd=". /usr/share/modules/init/bash; module use /opt/arm/modulefiles; module load acfl/24.10.1" }
360351
armflang --version
361352
```
362353

@@ -370,12 +361,12 @@ end program hello
370361
```
371362

372363
Build the application with:
373-
```bash { env_source="~/.bashrc", pre_cmd="module load acfl/24.10.1" }
364+
```console
374365
armflang hello.f90 -o hello
375366
```
376367

377368
Run the application with:
378-
```bash { env_source="~/.bashrc", pre_cmd="module load acfl/24.10.1" }
369+
```console
379370
./hello
380371
```
381372

content/install-guides/anaconda.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ test_images:
1515
- ubuntu:latest
1616
test_link: null
1717
test_maintenance: true
18-
test_status:
19-
- passed
2018
title: Anaconda
2119
tool_install: true
2220
weight: 1

content/install-guides/azure-cli.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ official_docs: https://learn.microsoft.com/en-us/cli/azure
1111
test_images:
1212
- ubuntu:latest
1313
test_maintenance: true
14-
test_status:
15-
- passed
1614
title: Azure CLI
1715
tool_install: true
1816
weight: 1

content/install-guides/dotnet.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,14 @@ test_images:
1111
- ubuntu:latest
1212
test_link: null
1313
test_maintenance: true
14-
test_status:
15-
- passed
1614
title: .NET SDK
1715
tool_install: true
1816
weight: 1
1917
---
2018

2119
The [.NET SDK](https://dotnet.microsoft.com/en-us/) is a free, open-source, and cross-platform development environment that provides a broad set of tools and libraries for building applications. You can use it to create a variety of applications including web apps, mobile apps, desktop apps, and cloud services.
2220

23-
The .NET SDK is available for Linux distributions on Arm-based systems.
21+
The .NET SDK is available for Linux distributions on Arm-based systems.
2422

2523
## What should I do before installing the .NET SDK on Arm Linux?
2624

@@ -44,7 +42,7 @@ There are two ways to install the .NET SDK on your computer:
4442
- Using the Linux package manager.
4543
- Using the install script.
4644

47-
Select the one that works best for you.
45+
Select the one that works best for you.
4846

4947
### How can I install .NET SDK using the Linux package manager?
5048

@@ -68,11 +66,11 @@ To install the .NET SDK using a script, follow the instructions below:
6866

6967
1. Download the install script:
7068

71-
```bash
69+
```bash
7270
wget https://dot.net/v1/dotnet-install.sh
7371
```
7472

75-
2. Run the script (it will install .NET SDK 8 under the folder .dotnet):
73+
2. Run the script (it will install .NET SDK 8 under the folder .dotnet):
7674

7775
You have some options to specify the version you want to install.
7876

@@ -104,9 +102,9 @@ You can also add the search path to your `$HOME/.bashrc` so it is set for all ne
104102

105103
## How do I verify the .NET SDK installation?
106104

107-
To check that the installation was successful, type:
105+
To check that the installation was successful, type:
108106

109-
```bash
107+
```bash
110108
dotnet --list-sdks
111109
```
112110

@@ -190,7 +188,7 @@ The expected output in the console is:
190188
Hello World!
191189
```
192190

193-
You are ready to use the .NET SDK on Arm Linux.
191+
You are ready to use the .NET SDK on Arm Linux.
194192

195193
You can find more information about .NET on Arm in the [AWS Graviton Technical Guide](https://github.com/aws/aws-graviton-getting-started/blob/main/dotnet.md).
196194

0 commit comments

Comments
 (0)