Skip to content

Commit

Permalink
Add trailing slashes (96boards#919)
Browse files Browse the repository at this point in the history
* Add trailing slashes

* Stop TOC being auto-generated

* Undo TOC changes done by plugin

Co-authored-by: Philip Colmer <[email protected]>
Co-authored-by: Kyle <[email protected]>
  • Loading branch information
3 people committed Feb 2, 2021
1 parent 16b3bca commit 17f6d68
Show file tree
Hide file tree
Showing 48 changed files with 80 additions and 80 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Thanks for stopping by to contribute the mezzanine-community repository! The fol
**NOTE: This documentation is solely for the 96Boards Documentation Repository, for filing bugs and issues about the boards themselves please refer to: [Report A Bug](Extras/Report_a_bug.md)**

## Table Of Contents

<!-- no toc -->
- [Bugs and Suggestions](#bugs-and-suggestions)
- [Contribution](#contribution)
- [General Contribution and Bug-Fixes](#general-contribution-and-bug-fixes)
Expand Down Expand Up @@ -95,7 +95,7 @@ We encourage our community members to submit 96Boards related guides to our repo

If you have recently launched a new 96Boards and have to add it to the documentation repository.
- Get yourself familiar with the [General Contribution and Bug-Fixes](#general-contribution-and-bug-fixes) topic.
- Arrange your documentation material following the [Template](templates/board-template)
- Arrange your documentation material following the [Template](templates/board-template/README.md){:target="_blank"}
- Each folder/section has a README.md file that acts like the "index.html" or front page of said section of the documentation. This can be used as an index or point-of-entry for said section of the documentation.
- **Boards Folder Structure:**
- ```<board-name/additional-docs/```:
Expand All @@ -111,9 +111,9 @@ If you have recently launched a new 96Boards and have to add it to the documenta
- ```<boards-name>/installation/>```: Instructions to install various pieces of software go here. These may include Kernel, OS, Bootlaoder etc.
- ```<boards-name>/support/>```: Any information relating to finding support for your board is placed here. This may include forum links and also links to other sections of this documentation.
- Copy you board folder under the right Edition category folder
- [Consumer Edition(CE)](consumer) ```/consumer/<board-name>/```
- [Enterprise Edition(EE)](enterprise) ```/enterprise/<board-name>/```
- [Internet of Things Edition(IE)](iot) ```/iot/<board-name>/```
- [Consumer Edition(CE)](consumer/) ```/consumer/<board-name>/```
- [Enterprise Edition(EE)](enterprise/) ```/enterprise/<board-name>/```
- [Internet of Things Edition(IE)](iot/) ```/iot/<board-name>/```
- Send in a Pull Request

**Things To Remember: Before sending the Pull request:**
Expand All @@ -136,7 +136,7 @@ If you have recently launched a new 96Boards and have to add it to the documenta
```
- And modify them according to your board
- Make sure to place all the images in the ```assets/images``` folder with the correct resolution as mentioned in the template.
- If your board has its guides section populated, make sure to add the board to our [guides page](guides) ```/guides/README.md```
- If your board has its guides section populated, make sure to add the board to our [guides page](guides/) ```/guides/README.md```
- Before submitting a Pull Request to the 96Boards repository, make sure to read and adhere to our guidelines mentioned in the [Guidelines for submitting a Pull Request](#guidelines-for-submitting-a-pull-request) section.
- Also take a look at our [Contribution Guide](https://www.youtube.com/playlist?list=PL-NF6S9MM_W1Lf714oYsSRIHT4bL_8P7e) play-list over at YouTube for short tutorials.

Expand Down
2 changes: 1 addition & 1 deletion consumer/avenger96/installation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This method requires the following hardware:
- USB Mouse and/or keyboard
- HDMI Monitor

Go to the [Downloads page](../downloads) to get your SD card image.
Go to the [Downloads page](../downloads/) to get your SD card image.

Proceed to installation instructions using [Etcher](https://etcher.io/)

Expand Down
2 changes: 1 addition & 1 deletion consumer/avenger96/installation/sd-etcher-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ redirect_from:

##### Step 5: Removed SD card from host machine and insert into Avenger96 board (on board SD card slot)

##### Step 6: Follow booting instructions from [Getting Started guide](../getting-started)
##### Step 6: Follow booting instructions from [Getting Started guide](../getting-started/)
4 changes: 2 additions & 2 deletions consumer/dragonboard/dragonboard820c/downloads/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ redirect_from: /documentation/consumer/dragonboard820c/downloads/debian.md.html
|[Download](http://snapshots.linaro.org/96boards/dragonboard820c/linaro/rescue/latest/dragonboard-820c-sdcard-rescue-*.zip) |
|[Release Notes](http://snapshots.linaro.org/96boards/dragonboard820c/linaro/rescue/latest/) |

### Continue to [Installation page](../installation)
### Continue to [Installation page](../installation/)

***

Expand All @@ -38,4 +38,4 @@ redirect_from: /documentation/consumer/dragonboard820c/downloads/debian.md.html
| [Developer](http://snapshots.linaro.org/96boards/dragonboard820c/linaro/debian/latest/linaro-*-developer-dragonboard-820c-*.img.gz) |
| [Release Notes](http://snapshots.linaro.org/96boards/dragonboard820c/linaro/debian/latest/) |

### Continue to [Installation page](../installation)
### Continue to [Installation page](../installation/)
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Choose one boot image, the root file system you choose will be based on the boot

Latest OpenEmbedded snapshot images can be found [HERE](http://snapshots.linaro.org/96boards/dragonboard820c/linaro/openembedded/). Once you have downloaded your pre-built images, proceed to the installation page.

## Continue to [Installation page](../installation)
## Continue to [Installation page](../installation/)
2 changes: 1 addition & 1 deletion consumer/dragonboard/dragonboard845c/downloads/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ Other operating systems supported on DragonBoard 845c, offered by partners.
- [Official AOSP for DragonBoard 845c](https://source.android.com/setup/build/devices#845cdragonboard), also check [Linaro additional instructions](https://wiki.linaro.org/AOSP/db845c)
- [LE OS (Based on Yocto Project)](https://thundercomm.s3.ap-northeast-1.amazonaws.com/shop/doc/1544580412842651/A845-2.160400.10.00120.1-P1-R-V01-201902221852_jde5r6s9xw.zip)

Continue to [Installation Page](../installation)
Continue to [Installation Page](../installation/)

***
2 changes: 1 addition & 1 deletion consumer/hikey/hikey970/build/aosp.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ $ make -j$(nproc)

# Installation

- Proceed to [Installation Instructions](../installation)
- Proceed to [Installation Instructions](../installation/)
2 changes: 1 addition & 1 deletion consumer/parrot/downloads/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ This pre-built Linux image provides users with a great development environment f

Coming Soon...

## Continue to [Installation page](../installation)
## Continue to [Installation page](../installation/)
6 changes: 3 additions & 3 deletions consumer/parrot/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ Please visit the [Hardware](/documentation/consumer/parrot/hardware-docs/files/p

If you are already familiar with the Parrot and would like to change out the stock operating system, please proceed to one of the following pages:

- [Downloads page](../downloads): This page lists all Linaro and 3rd party operating systems available for the Parrot
- [Installation page](../installation): If you already have the images you need, this page has information on how to install the different operating systems onto your Parrot
- [Downloads page](../downloads/): This page lists all Linaro and 3rd party operating systems available for the Parrot
- [Installation page](../installation/): If you already have the images you need, this page has information on how to install the different operating systems onto your Parrot
- [Guides](../guides/)
- [Support](../support)
- [Support](../support/)
- From bug reports and current issues, to forum access and other useful resources, we want to help you find answers

Back to the [Parrot documentation home page](../)
Expand Down
2 changes: 1 addition & 1 deletion consumer/rock/build/Android7-TV.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,4 +165,4 @@ $ ./android-gpt.sh

Will be generated `Image/gpt.img`

Proceed to [Installation Instructions](../installation)
Proceed to [Installation Instructions](../installation/)
2 changes: 1 addition & 1 deletion consumer/rock/build/Android7-Tablet.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,4 +173,4 @@ $ ./android-gpt.sh

Will be generated `Image/gpt.img`

Proceed to [Installation Instructions](../installation)
Proceed to [Installation Instructions](../installation/)
2 changes: 1 addition & 1 deletion consumer/rock/build/Android9.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,4 @@ $ ./android-gpt.sh

Will be generated `Image/gpt.img`

Proceed to [Installation Instructions](../installation)
Proceed to [Installation Instructions](../installation/)
2 changes: 1 addition & 1 deletion consumer/rock/build/aosp.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,4 +167,4 @@ $ ./android-gpt.sh

**rockdev/gpt.img** is the gpt image with all partitions.

Proceed to [Installation Instructions](../installation)
Proceed to [Installation Instructions](../installation/)
4 changes: 2 additions & 2 deletions consumer/rock/downloads/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ redirect_from: /documentation/consumer/rock960/downloads/debian.md.html
| All-in-one GPT image with bootloader/kernel/rootfs | [Debian Stretch Desktop armhf](https://dl.vamrs.com/products/rock960c/images/debian/rock960c_debian_stretch_lxde_armhf_20180920.tar.gz) |


This image can be flashed to eMMC from USB or write and run on a SD card. Continue to [Installation page](../installation)
This image can be flashed to eMMC from USB or write and run on a SD card. Continue to [Installation page](../installation/)

***

Expand Down Expand Up @@ -78,4 +78,4 @@ This image can be flashed to eMMC from USB or write and run on a SD card. Contin
|:------------------|:----------------------------------|
|Debian rootfs armhf | [debian_rootfs.img.gz](https://dl.vamrs.com/products/rock960c/images/debian/debian_rootfs_armhf_rockchip_release_20171108.img.gz) |

Continue to [Installation page](../installation)
Continue to [Installation page](../installation/)
4 changes: 2 additions & 2 deletions consumer/rock/downloads/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ redirect_from: /documentation/consumer/rock960/downloads/ubuntu.md.html
| SD Card/eMMC Image | Download |
|:------------------|:------------------------------------|
|All-in-one GPT image with bootloader/kernel/rootfs |[Ubuntu 16.04 Server arm64](https://dl.vamrs.com/products/rock960c/images/ubuntu/rock960_model_c_ubuntu_server_arm64_20181001-1845.tar.gz) |
This image can be flashed to eMMC from USB or write and run on a SD card. Continue to [Installation page](../installation)
This image can be flashed to eMMC from USB or write and run on a SD card. Continue to [Installation page](../installation/)

***

Expand Down Expand Up @@ -75,4 +75,4 @@ This image can be flashed to eMMC from USB or write and run on a SD card. Contin
|:------------------|:----------------------------------|
| Ubuntu 16.04 Server rootfs arm64 | [ubuntu_16.04_server_rootfs.img.gz](https://dl.vamrs.com/products/rock960c/images/ubuntu/partitions/rootfs/ubuntu_server_16.04_arm64_rootfs_20171108.ext4.gz) |

Continue to [Installation page](../installation)
Continue to [Installation page](../installation/)
4 changes: 2 additions & 2 deletions consumer/rock/installation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This method requires the following hardware:
- USB Mouse and/or keyboard (not required to perform flash)
- HDMI Monitor with full size HDMI cable (not required to perform flash)

Go to the [Downloads page](../downloads) to get your bootloader, boot image, and root file system image (rootfs).
Go to the [Downloads page](../downloads/) to get your bootloader, boot image, and root file system image (rootfs).

Choose host machine

Expand All @@ -58,7 +58,7 @@ This method requires the following hardware:
- USB Mouse and/or keyboard
- HDMI Monitor with full size HDMI cable

Go to the [Downloads page](../downloads) to get your SD card image.
Go to the [Downloads page](../downloads/) to get your SD card image.

Choose host machine

Expand Down
2 changes: 1 addition & 1 deletion consumer/rock/installation/linux-mac-rkdeveloptool.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Now you have rkdeveloptool executable at the current directory.

#### **Step 2**: Download all necessary images

Go to the [Downloads page](../downloads) to donwload the image.
Go to the [Downloads page](../downloads/) to donwload the image.

Extract the image tar ball, for SD card/eMMC AIO image, the file list as below:

Expand Down
2 changes: 1 addition & 1 deletion consumer/rock/installation/linux-upgrade_tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ should return

#### **Step 2**: Prepare necessary Android images

Go to the [Downloads page](../downloads) to donwload the image or use your own built one. _update.img_ is the default name if you follow the build instructions of [AOSP](../build/aosp.md). We use the name _-rkupdate.img_ to refer Rockchip format packed Android image.
Go to the [Downloads page](../downloads/) to donwload the image or use your own built one. _update.img_ is the default name if you follow the build instructions of [AOSP](../build/aosp.md). We use the name _-rkupdate.img_ to refer Rockchip format packed Android image.

It contains the following partitions:

Expand Down
6 changes: 3 additions & 3 deletions consumer/rock/rock960/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,9 @@ Please visit the [ROCK960 Hardware User Manual](../hardware-docs/hardware-user-m

If you are already familiar with the ROCK960 board and would like to change out the stock operating system, please proceed to one of the following pages:

- [Downloads page](../../downloads): This page lists all Linaro and 3rd party operating systems available for ROCK960
- [Installation page](../../installation): If you already have the images you need, this page has information on how to install the different operating systems onto your ROCK960 board
- [Troubleshooting](../../support)
- [Downloads page](../../downloads/): This page lists all Linaro and 3rd party operating systems available for ROCK960
- [Installation page](../../installation/): If you already have the images you need, this page has information on how to install the different operating systems onto your ROCK960 board
- [Troubleshooting](../../support/)
- From bug reports and current issues, to forum access and other useful resources, we want to help you find answers

Back to the [ROCK960 documentation home page](../)
Expand Down
2 changes: 1 addition & 1 deletion consumer/rock/rock960/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ redirect_from: /documentation/consumer/rock960/guides/

These guides will help to get you started with a variety of available on-boards software

- [Common guides for Rock boards](../../guides)
- [Common guides for Rock boards](../../guides/)

# ROCK960 Specific Guides

Expand Down
10 changes: 5 additions & 5 deletions consumer/rock/rock960c/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Please visit the [ROCK960 Model C Hardware User Manual](../hardware-docs/hardwar

### Download Image and tools

- Go to [Downloads page](../../downloads): This page lists all Linaro and 3rd party operating systems available for ROCK960 Model C. Choose an Image to download and unzip it.
- Go to [Downloads page](../../downloads/): This page lists all Linaro and 3rd party operating systems available for ROCK960 Model C. Choose an Image to download and unzip it.

- Download the flash tool, [Etcher](https://etcher.io). Choose the right version for your host operation system. Here we take Ubuntu as an example, other host OS are similar.
<img src="../additional-docs/images/images-install/linux_etcher_download_website.png" data-canonical-src="" width="250" height="160" />
Expand Down Expand Up @@ -176,11 +176,11 @@ Please visit the [ROCK960 Model C Hardware User Manual](../hardware-docs/hardwar

## What's Next?

- [Downloads page](../../downloads): This page lists all Linaro and 3rd party operating systems available for ROCK960 Model C. Try alternative images for ROCK960 Model C.
- [Downloads page](../../downloads/): This page lists all Linaro and 3rd party operating systems available for ROCK960 Model C. Try alternative images for ROCK960 Model C.

- [Installation page](../../installation): This page lists other installation method for ROCK960 Model C.
- [Userful Guide page](../../guides): This page lists some useful guide of using ROCK960 Model C.
- [Troubleshooting](../../support)
- [Installation page](../../installation/): This page lists other installation method for ROCK960 Model C.
- [Userful Guide page](../../guides/): This page lists some useful guide of using ROCK960 Model C.
- [Troubleshooting](../../support/)
- From bug reports and current issues, to forum access and other useful resources, we want to help you find answers

Back to the [ROCK960 documentation home page](../)
Expand Down
2 changes: 1 addition & 1 deletion consumer/rock/rock960c/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ permalink: /documentation/consumer/rock/rock960c/guides/

These guides will help to get you started with a variety of available on-boards software

- [Common guides for Rock boards](../../guides)
- [Common guides for Rock boards](../../guides/)

# ROCK960c Specific Guides

Expand Down
2 changes: 1 addition & 1 deletion consumer/sophon-edge/downloads/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ This pre-built Linux image provides users with a great development environment f

Coming Soon...

## Continue to [Installation page](../installation)
## Continue to [Installation page](../installation/)
6 changes: 3 additions & 3 deletions consumer/sophon-edge/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ Once the board powers up, the boot information will be printed on the UART termi

If you are already familiar with the Sophon Edge and would like to change out the stock operating system, please proceed to one of the following pages:

- [Downloads page](../downloads): This page lists all Linaro and 3rd party operating systems available for the Sophon Edge
- [Installation page](../installation): If you already have the images you need, this page has information on how to install the different operating systems onto your Sophon Edge
- [Downloads page](../downloads/): This page lists all Linaro and 3rd party operating systems available for the Sophon Edge
- [Installation page](../installation/): If you already have the images you need, this page has information on how to install the different operating systems onto your Sophon Edge
- [Guides](../guides/)
- [Support](../support)
- [Support](../support/)
- From bug reports and current issues, to forum access and other useful resources, we want to help you find answers

Back to the [Sophon Edge documentation home page](../)
Expand Down
2 changes: 1 addition & 1 deletion consumer/ultra96/ultra96-v1/downloads/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ This pre-built Linux image provides users with a great development environment f
|[Download](https://releases.linaro.org/96boards/ultra96/avnet/openembedded/latest/Ultra96_rev1_sdcard_image_180409.tar.gz) |
|[Release Notes](https://releases.linaro.org/96boards/ultra96/avnet/openembedded/latest/) |

## Continue to [Installation page](../installation)
## Continue to [Installation page](../installation/)
6 changes: 3 additions & 3 deletions consumer/ultra96/ultra96-v1/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,12 @@ The Ultra96 comes preloaded with Linux and can be up and running in two ways:

If you are already familiar with the Ultra96 and would like to change out the stock operating system, please proceed to one of the following pages:

- [Downloads page](../downloads): This page lists all Linaro and 3rd party operating systems available for the Ultra96
- [Installation page](../installation): If you already have the images you need, this page has information on how to install the different operating systems onto your Ultra96
- [Downloads page](../downloads/): This page lists all Linaro and 3rd party operating systems available for the Ultra96
- [Installation page](../installation/): If you already have the images you need, this page has information on how to install the different operating systems onto your Ultra96
- [Guides](../guides/)
- [Board Recovery](../installation/board-recovery.md)
- If at any time your board is having unexplainable issues, it is suggested to attempt a board recovery. These instructions will guide you through a succesfull board recovery.
- [Support](../support)
- [Support](../support/)
- From bug reports and current issues, to forum access and other useful resources, we want to help you find answers

Back to the [Ultra96 documentation home page](../)
Expand Down
2 changes: 1 addition & 1 deletion consumer/ultra96/ultra96-v1/installation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This method requires the following hardware:
- USB Mouse and/or keyboard
- Mini DisplayPort cable to HDMI or DisplayPort

Go to the [Downloads page](../downloads) to get your SD card image.
Go to the [Downloads page](../downloads/) to get your SD card image.

Proceed to installation instructions using [Etcher](https://etcher.io/)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ redirect_from:

##### Step 5: Removed SD card from host machine and insert into Ultra96 board (on board SD card slot)

##### Step 6: Follow booting instrutions from [Getting Started guide](../getting-started)
##### Step 6: Follow booting instrutions from [Getting Started guide](../getting-started/)
2 changes: 1 addition & 1 deletion consumer/ultra96/ultra96-v2/downloads/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ This pre-built Linux image provides users with a great development environment f
|[Download](http://avnet.me/ultra96-v2-oob) |
|Release Notes |

## Continue to [Installation page](../installation)
## Continue to [Installation page](../installation/)
Loading

0 comments on commit 17f6d68

Please sign in to comment.