Skip to content

Commit

Permalink
feat: add markdown link checker to validate links
Browse files Browse the repository at this point in the history
Signed-off-by: Asmit Malakannawar <asmitbm2952002@gmail.com>
  • Loading branch information
asmitbm committed Jul 13, 2023
1 parent c0a8fca commit 2b4cfc2
Show file tree
Hide file tree
Showing 7 changed files with 3,743 additions and 108 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/check_links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Check Markdown links

on:
pull_request:
branches:
- '**'

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Use Node
uses: actions/setup-node@v3
with:
node-version-file: 'package.json'
cache: 'npm'

- name: install dependencies
run: npm ci

- name: check internal markdown links
run: npm run check-links
2 changes: 1 addition & 1 deletion docs/Tutorials/zot-registry-tutorial.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ OCI registries are like a single location where container images and other artif

We will be using zot registry in this guide. Zot registry is an OCI-native container registry for distributing container images and OCI artifacts.

In order to follow the steps given, you would be required to install the ORAS CLI. You can follow the [installation guide](/docs/installation) to do so.
In order to follow the steps given, you would be required to install the ORAS CLI. You can follow the [installation guide](../installation.mdx) to do so.

### Phase 1: To Install Zot Registry

Expand Down
9 changes: 7 additions & 2 deletions docs/client_libraries/go.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
---
title: Go
sidebar_position: 1
---

# Go

Source code: [github.com/oras-project/oras-go](https://github.com/oras-project/oras-go)

## Introduction

The ORAS Go client library provides the ability to replicate artifacts between different [Targets](../#target).
The ORAS Go client library provides the ability to replicate artifacts between different [Targets](./overview.mdx#target).
Furthermore, the version `v2` is a registry client conforming [image-spec v1.1.0-rc.2](https://github.com/opencontainers/image-spec/releases/tag/v1.1.0-rc2) and [distribution-spec v1.1.0-rc1](https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc1/spec.md).

Using the ORAS Go client library, you can develop your own registry client:
Expand Down Expand Up @@ -244,7 +249,7 @@ func main() {
```

### Pull an Image using the Docker credential store
You can create a Docker credential store using [oras-credential-go](github.com/oras-project/oras-credentials-go).
You can create a Docker credential store using [oras-credential-go](https://github.com/oras-project/oras-credentials-go).

This enables you to use credentials that are saved by `docker login` in the client.

Expand Down
2 changes: 1 addition & 1 deletion docs/community/community_resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 10

## Developing and contributing to ORAS

If you are interested in developing or contributing to ORAS, you can check out the [CLI developer guide](./cli/developer_guide/).
If you are interested in developing or contributing to ORAS, you can check out the [CLI developer guide](./developer_guide.mdx).

## Governance

Expand Down
8 changes: 4 additions & 4 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Registries are evolving as generic artifact stores.
To enable this goal, the ORAS project provides a way to
push and pull OCI Artifacts to and from OCI Registries.

Users seeking a generic registry client can benefit from the [ORAS CLI](./installation), while
developers can build their own clients on top of one of the [ORAS client libraries](./client_libraries/overview).
Users seeking a generic registry client can benefit from the [ORAS CLI](./installation.mdx), while
developers can build their own clients on top of one of the [ORAS client libraries](./client_libraries/overview.mdx).

## What are OCI Registries?

Expand Down Expand Up @@ -67,6 +67,6 @@ application/vnd.unknown.config.v1+json
Authors of new OCI Artifacts are thus encouraged to define their own media types specific to
their artifact, which their custom client(s) know how to operate on.

If you wish to start publishing OCI Artifacts right away, take a look at the [ORAS CLI](./installation).
If you wish to start publishing OCI Artifacts right away, take a look at the [ORAS CLI](./installation.mdx).
Developers who wish to provide their own user experience should use one of the
[ORAS client libraries](./client_libraries/overview).
[ORAS client libraries](./client_libraries/overview.mdx).
Loading

0 comments on commit 2b4cfc2

Please sign in to comment.