Skip to content

Commit f52f9eb

Browse files
Merge pull request #1901 from jasonrandrews/review
Update more install guide heading to be questions
2 parents dc4f4d4 + 0816308 commit f52f9eb

18 files changed

+133
-133
lines changed

content/install-guides/aws-sam-cli.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ weight: 1
2020

2121
The Amazon Web Services (AWS) Serverless Application Model (SAM) CLI is an open-source command-line tool that you can use to build, test, and deploy serverless applications. The SAM CLI provides a Lambda-like execution environment that lets you locally build, test and debug applications defined by AWS SAM templates. It is available for a variety of operating systems and Linux distributions, and supports the Arm architecture.
2222

23-
## Before you begin
23+
## How do I prepare to install the AWS SAM CLI on Ubuntu?
2424

2525
Follow the instructions below to install and try the latest version of the AWS SAM CLI for Ubuntu on Arm.
2626

@@ -48,14 +48,14 @@ To install, run the following command:
4848
sudo apt install python-is-python3 python3-pip -y
4949
```
5050

51-
## Download and install the AWS SAM CLI
51+
## How do I download and install the AWS SAM CLI?
5252

5353
There are two options to install the SAM CLI, you can select your preferred method:
5454

5555
* From a zip file.
5656
* Using the Python `pip` command.
5757

58-
### Download and install from zip file
58+
### How do I download and install from a zip file?
5959

6060
Use `wget`:
6161

@@ -65,7 +65,7 @@ unzip aws-sam-cli-linux-arm64.zip -d sam-install
6565
sudo ./sam-install/install
6666
```
6767

68-
### Install the SAM CLI using Python pip
68+
### How do I install the AWS SAM CLI using Python pip?
6969

7070
```
7171
sudo apt install python3-venv -y
@@ -74,7 +74,7 @@ source .venv/bin/activate
7474
pip install aws-sam-cli
7575
```
7676

77-
### Confirm that the SAM CLI has been installed
77+
### How can I confirm that the AWS SAM CLI was installed correctly?
7878

7979
```bash
8080
sam --version
@@ -86,7 +86,7 @@ The version should be printed on screen:
8686
SAM CLI, version 1.125.0
8787
```
8888

89-
## Example application
89+
## How do I create an example application with the AWS SAM CLI?
9090

9191
You can use the AWS SAM CLI to build and deploy a simple "Hello World" serverless application that includes the line `uname -m` to check the platform it is running on, by following these steps.
9292

@@ -173,5 +173,5 @@ REPORT RequestId: 513dbd6f-7fc0-4212-ae13-a9a4ce2f21f4 Init Duration: 0.26 ms Du
173173
{"statusCode": 200, "body": "{\"message\": \"aarch64\\n\"}"}
174174
```
175175

176-
You are ready to use the AWS SAM CLI to build more complex functions and deploy them into AWS. Make sure to select `arm64` as the architecture for your Lambda functions.
176+
You are ready to use the AWS SAM CLI to build more complex functions and deploy them into AWS. Make sure to select `arm64` as the architecture for your Lambda functions.
177177

content/install-guides/aws_access_keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Copy the `Access key ID` and `Secret access key`
4646
![aws3 #center](https://github.com/ArmDeveloperEcosystem/arm-learning-paths/assets/40816837/699c3643-f979-4548-81f9-4300828b6a06 "Copy keys")
4747

4848

49-
## Configure the AWS CLI
49+
## How do I configure the AWS CLI?
5050

5151
Run the following command to set up your AWS CLI:
5252

content/install-guides/azure-cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ weight: 1
2020

2121
It is available for a variety of operating systems and Linux distributions and has multiple ways to install it.
2222

23-
## Before you begin
23+
## How do I prepare to install the Azure CLI on Ubuntu?
2424

2525
[General installation information](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli-linux?pivots=apt) is available which covers all supported Linux distributions. Starting with version 2.46.0, Azure CLI supports Arm64 Linux distributions. The 'apt' package manager contains both x86_64 and Arm64 packages for the following linux distributions
2626

2727
```output
2828
Ubuntu 20.04, Ubuntu 22.04, Ubuntu 24.04
2929
```
3030

31-
## Install via Azure CLI script
31+
## How do I install the Azure CLI using the installation script?
3232

3333
Confirm you are using an Arm machine by running:
3434

@@ -69,7 +69,7 @@ You should see an output similar to below
6969

7070
If you prefer installing the Azure CLI using Python3, follow the instructions below.
7171

72-
## Download and Install using pip
72+
## How do I download and install the Azure CLI using pip?
7373

7474
Another way to install Azure CLI for Ubuntu on Arm is to use Python pip.
7575

content/install-guides/azure_login.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar
2626

2727
In this section you will learn how to authenticate to the Azure environment using the Azure CLI. After log in, the CLI allows you to query and interact with Azure cloud resources.
2828

29-
## Before you begin
29+
## How do I prepare to authenticate using the Azure CLI?
3030

3131
Install the Azure CLI on your machine using the [install guide](/install-guides/azure-cli/).
3232

33-
## Sign in interactively
33+
## How do I sign in interactively to Azure?
3434

3535
Run the following command to initiate the log in:
3636

content/install-guides/forge.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ Linaro Forge consists of
2727
* [Linaro MAP](https://www.linaroforge.com/linaro-map/) for performance profiling and optimization advice, and
2828
* [Linaro Performance Reports](https://www.linaroforge.com/linaro-performance-reports/) for summarizing and characterizing both scalar and MPI application performance.
2929

30-
## Supported platforms
30+
## What platforms are supported by Linaro Forge?
3131

3232
Linaro Forge runs on Linux hosts and multiple architectures. See the Linaro Forge [documentation](https://docs.linaroforge.com/latest/html/forge/supported_platforms/reference_table.html) for a full list of supported configurations.
3333

3434
This install guide assumes an Arm AArch64 platform running Ubuntu Linux.
3535

36-
## Download
36+
## How do I download Linaro Forge?
3737

3838
Download and extract the appropriate installation package from [Linaro Forge Downloads](https://www.linaroforge.com/downloadForge/).
3939

@@ -43,9 +43,9 @@ wget https://downloads.linaroforge.com/24.0.3/linaro-forge-24.0.3-linux-aarch64.
4343
tar -xf linaro-forge-24.0.3-linux-aarch64.tar
4444
```
4545

46-
## Installation
46+
## How do I install Linaro Forge?
4747

48-
### Linux host
48+
### How do I install Linaro Forge on a Linux host?
4949

5050
Run the installer from the command line with:
5151

@@ -61,15 +61,15 @@ To install to the default directory, non-interactively:
6161
linaro-forge-24.0.3-linux-aarch64/textinstall.sh --accept-license /home/ubuntu/linaro/forge/24.0.3
6262
```
6363

64-
### Install on macOS (remote client only)
64+
### How do I install Linaro Forge on macOS (remote client only)?
6565

6666
Drag and drop the client application bundle icon into the Applications directory.
6767

68-
### Install on Windows (remote client only)
68+
### How do I install Linaro Forge on Windows (remote client only)?
6969

7070
Run the Windows file executable to install the Linaro Forge Remote Client.
7171

72-
### Graphical installer
72+
### How do I run the graphical installer for Linaro Forge?
7373

7474
Optionally, you can run the installer executable with a graphical interface.
7575

@@ -78,7 +78,7 @@ cd linaro-forge-24.0.3-linux-aarch64/
7878
./installer
7979
```
8080

81-
## Setting up the product license
81+
## How do I set up the product license for Linaro Forge?
8282

8383
You must install a license file on a machine running Linaro Forge tools to debug or profile.
8484

@@ -88,9 +88,9 @@ You do not need to install a license file on a machine running Linaro Forge Remo
8888

8989
[Free trial licenses](https://www.linaroforge.com/freeTrial/) are available for you try out Linaro Forge.
9090

91-
## Get started
91+
## How do I get started with Linaro Forge?
9292

93-
### Debugging
93+
### How do I debug using Linaro DDT?
9494

9595
When compiling the program that you want to debug, you must add the debug flag to your compile command. For most compilers this is `-g`.
9696

@@ -124,7 +124,7 @@ ddt --connect -n 128 myapp
124124

125125
This mode is called *Reverse Connect*. A window will appear in the GUI when the application runs to notify of the incoming request.
126126

127-
### Profiling
127+
### How do I profile an application with Linaro MAP?
128128

129129
In most cases, if your program is already compiled with debugging symbols (`-g`), you do not need to recompile your program to profile it with Linaro Forge. However, in some cases it might need to be relinked (see the [Linking](https://developer.arm.com/documentation/101136/latest/MAP/Get-started-with-MAP/Prepare-a-program-for-profiling)).
130130

@@ -150,7 +150,7 @@ A *.map file will be created in the current directory with profiling results whe
150150
map myapp_128p_<timestamp>.map
151151
```
152152

153-
### Performance Reports
153+
### How do I generate performance reports with Linaro Forge?
154154

155155
Linaro Forge's reporting tool Linaro Performance Reports is designed to run on unmodified production executables, so in general no preparation step is necessary. However, there is one important exception: statically linked applications require additional libraries at the linking step (see [user guide](https://developer.arm.com/documentation/101136/latest/Performance-Reports/Run-real-programs)).
156156

content/install-guides/fvps-on-macos.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar
2828
---
2929
This guide is intended to get you up and running with the [Arm Virtual Hardware (AVH) Fixed Virtual Platforms (FVPs)](https://www.arm.com/products/development-tools/simulation/virtual-hardware) on macOS. For a thorough review of all options, refer to the official documentation.
3030

31-
## Prerequisites
31+
## What are the prerequisites for running AVH FVPs on macOS?
3232

3333
[Install Docker Desktop on Mac](https://docs.docker.com/desktop/install/mac-install/).
3434

3535
If this is for commercial use, you might require a paid subscription.
3636

37-
## Clone the repo
37+
## How do I clone the repository?
3838

3939
Open a terminal and set the working directory to the location in which you would like to store the Fast Model. Then run:
4040

@@ -44,7 +44,7 @@ git clone https://github.com/Arm-Examples/FVPs-on-Mac.git
4444

4545
This creates the subdirectory `FVPs-on-Mac` in the current working directory.
4646

47-
## Build the Docker wrapper
47+
## How do I build the Docker wrapper for AVH FVPs?
4848

4949
Run the build script to create the Docker image and populate the `bin` folder with model wrappers:
5050

@@ -60,7 +60,7 @@ These wrappers can be used exactly like any native model executable:
6060
./bin/FVP_MPS2_Cortex-M3 --version
6161
```
6262

63-
## Expose models to local environment
63+
## How do I expose the models to my local environment?
6464

6565
Add `$(pwd)/FVPs-on-Mac/bin` to `PATH` environment:
6666

content/install-guides/gfortran.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,7 @@ weight: 1
2525

2626
[GNU Fortran](https://gcc.gnu.org/fortran/) is the Fortran compiler front end and run-time libraries for GCC, the GNU Compiler Collection.
2727

28-
GFortran is available on all Linux distributions and can be installed using the package manager.
29-
30-
## Before you begin
31-
32-
Follow the instructions below to install and use `gfortran` on an Arm Linux distribution.
28+
## How do I prepare to install and use gfortran on an Arm Linux distribution?
3329

3430
Confirm you are using an Arm machine by running:
3531

@@ -45,13 +41,11 @@ aarch64
4541

4642
If you see a different result, you are not using an Arm computer running 64-bit Linux.
4743

48-
## Download
44+
## How do I download gfortran using the Linux package manager?
4945

5046
The Linux package manager downloads the required files so there are no special instructions.
5147

52-
## Installation {#install}
53-
54-
### Installing on Debian based distributions such as Ubuntu
48+
### How do I install gfortran on Debian-based distributions such as Ubuntu?
5549

5650
Use the `apt` command to install software packages on any Debian based Linux distribution, including Ubuntu.
5751

@@ -60,7 +54,7 @@ sudo apt update
6054
sudo apt install gfortran -y
6155
```
6256

63-
### Installing on Red Hat / Fedora / Amazon Linux
57+
### How do I install gfortran on Red Hat, Fedora, or Amazon Linux?
6458

6559
These Linux distributions use `yum` as the package manager.
6660

@@ -78,12 +72,11 @@ sudo yum update -y
7872
sudo yum install gcc-gfortran -y
7973
```
8074

81-
82-
## Setting up product license {#license}
75+
## Do I need to set up a product license for gfortran?
8376

8477
Arm GNU Toolchain is open source and freely available for use. No licenses need to be set up for use.
8578

86-
## Get started {#start}
79+
## How do I verify the gfortran installation and get started?
8780

8881
To confirm the installation is complete run:
8982

content/install-guides/llvm-embedded.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The [LLVM Embedded Toolchain for Arm](https://github.com/ARM-software/LLVM-embed
3131

3232
[Pre-built binaries](https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases) are available for Windows (x86_64), macOS (x86_64 and Apple Silicon), and Linux (x86_64 and AArch64) hosts.
3333

34-
## Windows {#windows}
34+
## How do I install the LLVM Embedded Toolchain for Arm on Windows? {#windows}
3535

3636
Copy and paste the URL below into your browser to download the latest release from GitHub:
3737

@@ -45,7 +45,7 @@ Open Windows `Control Panel` and add the LLVM `bin` directory to the `Path`.
4545

4646
Open a `Command Prompt` and [test your installation](#test).
4747

48-
## macOS {#macos}
48+
## How do I install the LLVM Embedded Toolchain for Arm on macOS? {#macos}
4949

5050
Copy and paste the URL below into your browser to download the latest release from GitHub:
5151

@@ -70,7 +70,7 @@ find . -type f -perm +0111 | xargs xattr -d com.apple.quarantine
7070

7171
You can now [test your installation](#test).
7272

73-
## Linux {#linux}
73+
## How do I install the LLVM Embedded Toolchain for Arm on Linux? {#linux}
7474

7575
The information below assumes `Ubuntu Linux` on an `AArch64` host. Modify the filenames and paths as needed for other hosts.
7676

@@ -92,11 +92,11 @@ Add the LLVM `bin` directory to your `PATH`:
9292
export PATH=$HOME/LLVM-ET-Arm-18.1.3-Linux-AArch64/bin:$PATH
9393
```
9494

95-
You can now [test your installation](#test).
95+
## How do I test the LLVM Embedded Toolchain installation? {#test}
9696

97-
## Test installation {#test}
97+
You can now test your installation.
9898

99-
### Verify the clang installation
99+
### How do I verify the clang installation?
100100

101101
Use the `--version` option to verify the correct compiler is being invoked:
102102

@@ -113,7 +113,7 @@ Thread model: posix
113113
InstalledDir: /home/ubuntu/LLVM-ET-Arm-18.1.3-Linux-AArch64/bin
114114
```
115115

116-
### Build a simple application
116+
### How do I build a simple application with clang?
117117

118118
Use a text editor to create an example source file with the name `hello.c` and the code below:
119119

@@ -141,7 +141,7 @@ To build for `Armv7-M`:
141141
clang --target=armv7m-none-eabi -fno-exceptions -fno-rtti -lcrt0-semihost -lsemihost -T picolibc.ld -o hello_v7m hello.c
142142
```
143143

144-
### Run the examples
144+
### How do I run the example applications?
145145

146146
The applications can be run on [Fixed Virtual Platforms (FVP)](/install-guides/fm_fvp/fvp/).
147147

content/install-guides/llvm-woa.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install ar
3131

3232
[LLVM version 12 or higher](https://llvm.org/) natively supports Windows on Arm. [View the supported Arm architecture features](https://developer.arm.com/Tools%20and%20Software/LLVM%20Toolchain#Supported-Devices) in the open-sourced LLVM toolchain.
3333

34-
## Download and install
34+
## How do I download and install the LLVM toolchain for Windows on Arm?
3535

3636
The latest version (at the time of writing) of the LLVM toolchain with Windows on Arm native support is 18.1.8. [Download the pre-built binary](https://github.com/llvm/llvm-project/releases/download/llvmorg-18.1.8/LLVM-18.1.8-woa64.exe).
3737

@@ -53,7 +53,7 @@ The setup will complete successfully. Select `Finish` to close the installer.
5353

5454
![img2 #center](/install-guides/_images/llvm-finish.png)
5555

56-
## Check the installation
56+
## How do I check the LLVM toolchain installation?
5757

5858
Open a Windows Command prompt or a PowerShell prompt and run:
5959

@@ -69,7 +69,7 @@ Thread model: posix
6969
InstalledDir: C:\Program Files\LLVM\bin
7070
```
7171

72-
## Other versions of LLVM
72+
## What other LLVM versions are available?
7373

7474
You can download other LLVM builds from [the download repository](https://releases.llvm.org/download.html).
7575

0 commit comments

Comments
 (0)