WindowsPerf Arm Learning Path Contribution HOWTO

Owned by Przemyslaw Wirkus
Last updated: Oct 10, 2024
3 min read

Table of Contents

Introduction

In this short document we will describe how use can contribute to https://learn.arm.com/ - Learning Path for WindowsPerf.

Please see https://learn.arm.com/learning-paths/cross-platform/_example-learning-path/setup/ learning path to understand how to install and contribute to arm Learning Path in general. This document will explain how to contribute to existing WindowsPerf learning path.

Prerequisites

Contribute

  1. In order to contribute and send pull requests to Learning Path repo you must create https://github.com/ArmDeveloperEcosystem/arm-learning-paths fork. Go to arm-learning-path GitHub page and with your user account create fork.

  2. Clone your arm-learning-path fork locally.

git clone https://github.com/<your-github-account-name>/arm-learning-paths

  1. Download Hugo and unzip it to directory where you usually store your binaries. Or add hugo.exe to system PATH. Note: Hugo is distributed as standalone binary.

  2. Go to arm-learning-paths fork folder you’ve just cloned and run hugo.exe server command in it:

cd arm-learning-paths/ hugo server

You will see:

Watching for changes in D:\repos\github_forks\arm-learning-paths\{archetypes,assets,content,data,themes} Watching for config changes in D:\repos\github_forks\arm-learning-paths\config.toml Start building sites … hugo v0.120.3-a4892a07b41b7b3f1f143140ee4ec0a9a5cf3970 windows/amd64 BuildDate=2023-11-01T17:57:00Z VendorInfo=gohugoio WARN .File.Dir on zero object. Wrap it in if or with: {{ with .File }}{{ .Dir }}{{ end }} WARN .File.TranslationBaseName on zero object. Wrap it in if or with: {{ with .File }}{{ .TranslationBaseName }}{{ end }} | EN -------------------+------- Pages | 1175 Paginator pages | 0 Non-page files | 412 Static files | 58 Processed images | 0 Aliases | 0 Sitemaps | 1 Cleaned | 0 Built in 6413 ms Environment: "development" Serving pages from memory Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender Web Server is available at //localhost:1313/ (bind address 127.0.0.1) Press Ctrl+C to stop

  1. You can now open http://localhost:1313 webpage with prerendered Learning Path:

  1. Some of the WindowsPerf articles are under “Laptops & Desktops”. You can go directly to http://localhost:1313/learning-paths/laptops-and-desktops/ and search for WindowsPerf keyword:

Note: Hugo server will automatically refresh content of Learning Path page when you update content, especially markdown files.

  1. You will find WindowsPerf content in arm-learning-path here:

WindowsPerf Learning Path articles

WindowsPerf Learning Path articles

arm-learning-paths\content\learning-paths\laptops-and-desktops\windowsperf\*.md

arm-learning-paths\content\install-guides\wperf.md

Sending pull request to arm-learning-paths repo

  1. Create new branch in your fork.

  2. Update / add new content to Learning Path.

  3. Commit your changes locally.

  4. Git push your local branch to your remote fork.

  5. You can use GitHub online interface to create pull request.

You can see some of the WindowsPerf pull requests here.