Skip to content

Commit

Permalink
patch: Fix links in Glossary and base images
Browse files Browse the repository at this point in the history
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipulgupta2048@gmail.com>
  • Loading branch information
vipulgupta2048 committed Dec 21, 2023
1 parent 17c9196 commit 7bb7b34
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
13 changes: 13 additions & 0 deletions .github/workflows/link-checker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ jobs:
node-version: 16
- run: npm run deploy-docs

- uses: actions/cache@v3
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-

# Run link checker on the generated HTML
- name: Link Checker
id: lychee
Expand All @@ -47,3 +53,10 @@ jobs:
title: Link Checker Report
content-filepath: ./lychee/out.md
labels: good-first-issue, automated issue

- name: Save lychee cache
uses: actions/cache/save@v3
if: always()
with:
path: .lycheecache
key: ${{ steps.restore-cache.outputs.cache-primary-key }}
4 changes: 2 additions & 2 deletions lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ progress = true
cache = true

# Discard all cached requests older than this duration.
max_cache_age = "2d"
max_cache_age = "1d"

############################# Runtime #############################

Expand Down Expand Up @@ -118,7 +118,7 @@ exclude = [
]

# Exclude these filesystem paths from getting checked.
exclude_path = ["./build/img/", "./build/css/", "./build/favicon.png", "./build/dist/"]
exclude_path = ["./build/img/", "./build/css/", "./build/favicon.png", "./build/dist/", ".build/reference/base-images/base-images-ref/"]

include = []

Expand Down
6 changes: 3 additions & 3 deletions pages/learn/develop/hardware/i2c-and-spi.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ The best and easiest way to interface with GPIO, I2C, SPI or UART on the Intel E
[MRAA library][mraa-link], this library gives you a simple way to write C, python or Node.js applications that
interact directly with the Edison hardware.

If you use our [{{ $names.base_images.lib }}/edison-node][dockerbase-node] or [{{ $names.base_images.lib }}/edison-python][dockerbase-python] base images in your applications, you will automatically have the mraa setup correctly for node.js or python respectively.
If you use our [{{ $names.base_images.lib }}/intel-edison-node][dockerbase-node] or [{{ $names.base_images.lib }}/intel-edison-python][dockerbase-python] base images in your applications, you will automatically have the mraa setup correctly for node.js or python respectively.

Have a look at this [python example](https://github.com/shaunmulligan/hello-python-edison) or this [node.js example](https://github.com/shaunmulligan/edison-blink-node) to get started.

Expand Down Expand Up @@ -356,7 +356,7 @@ After the custom device tree has been validated, it can be included in newer bal
[picamera-link]:{{ $links.githubLabs }}/balena-rpi-python-picamera
[mraa-link]:https://github.com/intel-iot-devkit/mraa
[upm-link]:https://github.com/intel-iot-devkit/upm
[dockerbase-node]:https://hub.docker.com/r/{{ $names.base_images.lib }}/edison-node/
[dockerbase-python]:https://hub.docker.com/r/{{ $names.base_images.lib }}/edison-python/
[dockerbase-node]:https://hub.docker.com/r/{{ $names.base_images.lib }}/intel-edison-node/
[dockerbase-python]:https://hub.docker.com/r/{{ $names.base_images.lib }}/intel-edison-python/
[dt-params]:/reference/OS/advanced/#setting-device-tree-overlays-dtoverlay-and-parameters-dtparam
[device-configuration]:/learn/manage/configuration/#device-configuration-management
2 changes: 0 additions & 2 deletions pages/learn/more/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ A marketplace that enables the exchange of resources between our users. At a hig
### balenaMachine
**(balena specific term)**
On-premises fleet management, delivered as a single virtual machine that includes all core balenaCloud services.
[more](https://docs.google.com/document/d/1WHT9RnX9h1GsMWZUhVk5GxEBghUbjTdyu4ivc0xSPmk/edit?usp=sharing)

### balenaOS
**(balena specific term)**
Expand Down Expand Up @@ -405,7 +404,6 @@ Balena's on-device agent, responsible for monitoring and applying changes to an
### testbot
**(balena specific term)**
The testbot is a device used to aid in the automation of hardware testing. It connects to a balena fin through a HAT interface, and provides a mechanism to remotely provision, power, and run a test suite against a device under test (DUT). Testbot’s vision is to completely isolate the DUT when testing it much like an octopus around its prey. We control the power, network type and the image flashed to the DUT.
[more](https://docs.google.com/document/d/1UiKDVHHp9HUZrBW2kE9FjKwSLb8BTtlDw_FEqyTWHLY/edit)

## U

Expand Down

0 comments on commit 7bb7b34

Please sign in to comment.