Skip to content

Commit

Permalink
chore(CI): not check local urls for the md files (#3260)
Browse files Browse the repository at this point in the history
* not check local urls for the md lint checker and use local urls instead full url

* remove quiet mode

* replace base url for local files

* fix base url for local links

* fix base url

* test a break link

* test a break link

* fix some broken links

* fix bounty link

* fix patterns

* fix youtube link

* remove unuseless / in the end of the url
  • Loading branch information
Pantani authored Dec 8, 2022
1 parent 5342442 commit a645f1e
Show file tree
Hide file tree
Showing 28 changed files with 68 additions and 58 deletions.
11 changes: 11 additions & 0 deletions .github/workflows/md-link-checker-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,24 @@
{
"pattern": "^https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax"
},
{
"pattern": "^https://docs.starport.network"
},
{
"pattern": "^http://localhost"
},
{
"pattern": "^index.md"
}
],
"replacementPatterns": [
{
"pattern": "^/",
"replacement": "https://docs.ignite.com/"
}
],
"baseUrl": "https://docs.ignite.com",
"projectBaseUrl": "https://docs.ignite.com",
"timeout": "20s",
"retryOn429": true,
"retryCount": 5,
Expand Down
3 changes: 1 addition & 2 deletions .github/workflows/md-link-checker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ jobs:
- uses: actions/[email protected]
- uses: gaurav-nelson/[email protected]
with:
folder-path: "docs"
use-quiet-mode: 'yes'
folder-path: "."
use-verbose-mode: 'yes'
config-file: '.github/workflows/md-link-checker-config.json'
8 changes: 4 additions & 4 deletions .gitpod/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ ignite chain serve
curl https://get.ignite.com/cli | bash
```

The latest `ignite` binary is downloaded from the project repo and installed in `/usr/local/bin`. Learn more about [installing Ignite CLI](https://docs.ignite.com/guide/install.html).
The latest `ignite` binary is downloaded from the project repo and installed in `/usr/local/bin`. Learn more about [installing Ignite CLI](https://docs.ignite.com/guide/install).

## Stay in touch

Expand All @@ -54,8 +54,8 @@ Ignite CLI is a free and open source product maintained by [Ignite](https://igni

* [ignite.com website](https://ignite.com)
* [@ignite_dev on Twitter](https://twitter.com/ignite_dev)
* [ignite.com/blog](https://ignite.com/blog/)
* [ignite.com/blog](https://ignite.com/blog)
* [Ignite Discord](https://discord.gg/ignite)
* [Ignite YouTube](https://www.youtube.com/channel/ignitehq)
* [Ignite docs](https://docs.ignite.com/)
* [Ignite YouTube](https://www.youtube.com/@ignitehq)
* [Ignite docs](https://docs.ignite.com)
* [Ignite jobs](https://ignite.com/careers)
4 changes: 2 additions & 2 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Review the issues and discussions before you open a PR.

Avoid long names in your PR titles. Make sure your title has fewer than 60 characters.

Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines and keywords to find the best
Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) guidelines and keywords to find the best
title.

Use parentheses to identify the package or feature that you worked on. For example: `feat(services/chain)`
Expand Down Expand Up @@ -69,7 +69,7 @@ used as the commit message.
When you open a PR for the Ignite CLI codebase, you must also update the relevant documentation. For changes to:

* [Developer Guide](https://docs.ignite.com/guide) tutorials, update content in the `/docs/guide` folder.
* [Knowledge Base](https://docs.ignite.com/kb/), update content in the `/docs/kb` folder.
* [Knowledge Base](https://docs.ignite.com/kb), update content in the `/docs/kb` folder.
* [Ignite CLI reference](https://docs.ignite.com/cli), navigate to the `./ignite/cmd` package and update the
documentation of the related command from its `cobra.Command` struct. The CLI docs are automatically generated, so do
not make changes to `docs/cli/index.md`.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/clients/01-typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ ignite generate ts-client

## Setup

The best way to get started building with the TypeScript client is by using a [Vite](https://vitejs.dev/) boilerplate.
The best way to get started building with the TypeScript client is by using a [Vite](https://vitejs.dev) boilerplate.
Vite provides boilerplate code for vanilla TS projects as well as react, vue, lit, svelte and preact frameworks.
You can find additional information at the [Vite Getting Started guide](https://vitejs.dev/guide/).
You can find additional information at the [Vite Getting Started guide](https://vitejs.dev/guide).

You will also need to polyfill the client's dependencies. The following is an example of setting up a vanilla TS
project with the necessary polyfills.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/contributing/02-technical-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ technical setup.

## Setting up Visual Studio Code

1. Install [Visual Studio Code](https://vscode-docs.readthedocs.io/en/latest/editor/setup/).
1. Install [Visual Studio Code](https://vscode-docs.readthedocs.io/en/latest/editor/setup).
2. Click **Extensions** in the sidebar.
3. Install this extension:
- Go for VS Code The official Go extension for Visual Studio Code
Expand Down Expand Up @@ -39,7 +39,7 @@ Master your terminal to be happy.

### iTerm2 terminal emulator

On macOS, install the [iTerm2](https://iterm2.com/) OSS terminal emulator as a replacement for the default Terminal app.
On macOS, install the [iTerm2](https://iterm2.com) OSS terminal emulator as a replacement for the default Terminal app.
Installing iTerm2 as a replacement for Terminal provides an updated version of the Bash shell that supports useful
features like programmable completion.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/contributing/templates/02-tutorial-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ To complete this tutorial, you will need:

<!-- Example - uncomment to use
- A supported version of [Ignite CLI](https://docs.ignite.com/). To install Ignite CLI, see [Install Ignite CLI](../../guide/01-install.md).
- A supported version of [Ignite CLI](/). To install Ignite CLI, see [Install Ignite CLI](../../guide/01-install.md).
* A text editor like [Visual Studio Code](https://code.visualstudio.com/download).
* A web browser like [Chrome](https://www.google.com/chrome/) or [Firefox](https://www.mozilla.org/en-US/firefox/new/).
* A web browser like [Chrome](https://www.google.com/chrome) or [Firefox](https://www.mozilla.org/en-US/firefox/new).
-->

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guide/02-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ following command:
ignite scaffold chain example
```

The [`ignite scaffold chain`](https://docs.ignite.com/cli#ignite-scaffold-chain) command will create a
The [`ignite scaffold chain`](/cli#ignite-scaffold-chain) command will create a
new blockchain in a new directory `example`.

The new blockchain is built using the Cosmos SDK framework and imports several
Expand Down Expand Up @@ -132,7 +132,7 @@ To start a blockchain node in development, you can run the following command:
ignite chain serve
```

The [`ignite chain serve`](https://docs.ignite.com/cli#ignite-scaffold-chain) command is used to start
The [`ignite chain serve`](/cli#ignite-scaffold-chain) command is used to start
a blockchain node in development mode. It first compiles and installs the binary
using the `ignite chain build` command, then initializes the blockchain's data
directory for a single validator using the `ignite chain init` command. After
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guide/05-nameservice/00-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ blockchain app developer, you have to define the state machine with a starting
state and messages that trigger state transitions. These software components
make it all possible!

- [Ignite CLI](https://docs.ignite.com/) is built on top of Cosmos SDK and
- [Ignite CLI](/) is built on top of Cosmos SDK and
accelerates chain development by scaffolding everything you need.
- The [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) modular framework
- The [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) modular framework
allows developers like you to create custom blockchains that can natively
interact with other blockchains.
- [Tendermint](https://docs.tendermint.com/main/introduction/what-is-tendermint.html)
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guide/05-nameservice/01-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ so that end users can buy names and set a value to the names.
## Create a Blockchain

Scaffold a new Cosmos SDK blockchain using the `ignite scaffold chain` command.
The [`ignite scaffold chain`](https://docs.ignite.com/cli#ignite-scaffold-chain)
The [`ignite scaffold chain`](/cli#ignite-scaffold-chain)
command accepts one argument: the Go module path that is used for the project.

By default, a chain is scaffolded with a new empty Cosmos SDK module. You want
Expand Down Expand Up @@ -52,7 +52,7 @@ ignite scaffold module nameservice --dep bank

## Results

The [`ignite scaffold module`](https://docs.ignite.com/cli#ignite-scaffold-module) command has done all the work for you!
The [`ignite scaffold module`](/cli#ignite-scaffold-module) command has done all the work for you!

- The `nameservice` module was created in the `x/nameservice` directory.
- The `nameservice` module was imported into the blockchain in the `app/app.go`
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guide/05-nameservice/02-messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Use the `ignite scaffold message` command to scaffold new messages for your
module.

- The [`ignite scaffold
message`](https://docs.ignite.com/#ignite-scaffold-message) command accepts
message`](/cli#ignite-scaffold-message) command accepts
the message name as the first argument and a list of fields for the message.
- By default, a message is scaffolded in a module with a name that matches the
name of the project, in this case `nameservice`.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guide/05-nameservice/03-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For the nameservice blockchain, define a `whois` type and the create and delete
methods.

Because Ignite CLI does the heavy lifting for you, choose from several [ignite
scaffold](https://docs.ignite.com/cli#ignite-scaffold) commands to create CRUD
scaffold](/cli#ignite-scaffold) commands to create CRUD
functionality code for data stored in different ways:

- Array, a list-like data structure
Expand All @@ -25,7 +25,7 @@ functionality code for data stored in different ways:

## Add the whois Type

Use the [`ignite scaffold map`](https://docs.ignite.com/cli#ignite-scaffold-map)
Use the [`ignite scaffold map`](/cli#ignite-scaffold-map)
command to scaffold the `whois` type and create the code that implements CRUD
functionality to create, read, update, and delete information about names.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guide/08-loan.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Use the `--dep` flag to specify that this module depends on and is going to inte

## Scaffold a list

Use the [scaffold list](https://docs.ignite.com/cli#ignite-scaffold-list) command to scaffold code necessary to store
Use the [scaffold list](/cli#ignite-scaffold-list) command to scaffold code necessary to store
loans in an array-like data structure:

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/kb/07-frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ client:
path: vue/src/store
```
When using this configuration a TS client is generated in the `ts-client` directory (see: [TypeScript client information](https://docs.ignite.com/clients/typescript))
When using this configuration a TS client is generated in the `ts-client` directory (see: [TypeScript client information](/clients/typescript))
and Vuex store modules making use of this client are generated in the `vue/src/store` directory.

## Client code generation
Expand Down
2 changes: 1 addition & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus 2](https://docusaurus.io), a modern static website generator.

### Installation

Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-v0.25.2/clients/01-typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ To prevent regenerating the client, remove the `client:typescript` property from

## Setup

The best way to get started building with the TypeScript client is by using a [Vite](https://vitejs.dev/) boilerplate. Vite provides boilerplates for vanilla TS projects as well as react, vue, lit, svelte and preact frameworks.
You can find additional information at the [Vite Getting Started guide](https://vitejs.dev/guide/).
The best way to get started building with the TypeScript client is by using a [Vite](https://vitejs.dev) boilerplate. Vite provides boilerplates for vanilla TS projects as well as react, vue, lit, svelte and preact frameworks.
You can find additional information at the [Vite Getting Started guide](https://vitejs.dev/guide).

You will also need to polyfill the client's dependencies. The following is an example of setting up a vanilla TS project with the necessary polyfills.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ To ensure you have a successful experience working with our Developer Tutorials

## Setting up Visual Studio Code

1. Install [Visual Studio Code](https://vscode-docs.readthedocs.io/en/latest/editor/setup/).
1. Install [Visual Studio Code](https://vscode-docs.readthedocs.io/en/latest/editor/setup).
1. Click **Extensions** in the sidebar.
1. Install this extension:
- Go for VS Code The official Go extension for Visual Studio Code
Expand Down Expand Up @@ -35,7 +35,7 @@ Master your terminal to be happy.

### iTerm2 terminal emulator

On macOS, install the [iTerm2](https://iterm2.com/) OSS terminal emulator as a replacement for the default Terminal app. Installing iTerm2 as a replacement for Terminal provides an updated version of the Bash shell that supports useful features like programmable completion.
On macOS, install the [iTerm2](https://iterm2.com) OSS terminal emulator as a replacement for the default Terminal app. Installing iTerm2 as a replacement for Terminal provides an updated version of the Bash shell that supports useful features like programmable completion.

### Using ZSH as your default shell

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ To complete this tutorial, you will need:

<!-- Example - uncomment to use
- A supported version of [Ignite CLI](https://docs.ignite.com/). To install Ignite CLI, see [Install Ignite CLI](../../guide/01-install.md).
- A supported version of [Ignite CLI](/). To install Ignite CLI, see [Install Ignite CLI](../../guide/01-install.md).
* A text editor like [Visual Studio Code](https://code.visualstudio.com/download).
* A web browser like [Chrome](https://www.google.com/chrome/) or [Firefox](https://www.mozilla.org/en-US/firefox/new/).
* A web browser like [Chrome](https://www.google.com/chrome) or [Firefox](https://www.mozilla.org/en-US/firefox/new).
-->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ This tutorial guides you through these steps to build a blockchain for a nameser

## Prerequisites

- A supported version of [Ignite CLI](https://docs.ignite.com/). To install Ignite CLI, see [Install Ignite CLI](../01-install.md).
- A supported version of [Ignite CLI](/). To install Ignite CLI, see [Install Ignite CLI](../01-install.md).
* A text editor like [Visual Studio Code](https://code.visualstudio.com/download).
* A web browser like [Chrome](https://www.google.com/chrome/) or [Firefox](https://www.mozilla.org/en-US/firefox/new/).
* A web browser like [Chrome](https://www.google.com/chrome) or [Firefox](https://www.mozilla.org/en-US/firefox/new).
- Familiarity with [Cosmos SDK modules](https://docs.cosmos.network/main/building-modules/intro.html)

## Nameservice App Goals
Expand All @@ -41,8 +41,8 @@ First, see how these simple requirements translate to app design.

A blockchain app is a [replicated deterministic state machine](https://en.wikipedia.org/wiki/State_machine_replication). As a blockchain app developer, you have to define the state machine with a starting state and messages that trigger state transitions. These software components make it all possible!

- [Ignite CLI](https://docs.ignite.com/) is built on top of Cosmos SDK and accelerates chain development by scaffolding everything you need.
- The [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) modular framework allows developers like you to create custom blockchains that can natively interact with other blockchains.
- [Ignite CLI](/) is built on top of Cosmos SDK and accelerates chain development by scaffolding everything you need.
- The [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) modular framework allows developers like you to create custom blockchains that can natively interact with other blockchains.
- [Tendermint](https://docs.tendermint.com/main/introduction/what-is-tendermint.html) software securely and consistently replicates an app on many machines. The Tendermint app-agnostic engine handles the networking and consensus layers of your blockchain.

## Cosmos SDK Modules
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Scaffold a blockchain and create a `nameservice` module for the nameservice app.

## Create a Blockchain

Scaffold a new Cosmos SDK blockchain using the `ignite scaffold chain` command. The [ignite scaffold chain](https://docs.ignite.com/cli#ignite-scaffold-chain) command accepts one argument: the Go module path that is used for the project.
Scaffold a new Cosmos SDK blockchain using the `ignite scaffold chain` command. The [ignite scaffold chain](/cli#ignite-scaffold-chain) command accepts one argument: the Go module path that is used for the project.

By default, a chain is scaffolded with a new empty Cosmos SDK module. You want to create the nameservice module without scaffolding a module, so use the `--no-module` flag:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Now, you are ready to implement these Cosmos SDK messages to achieve the desired

Use the `ignite scaffold message` command to scaffold new messages for your module.

- The [`ignite scaffold message`](https://docs.ignite.com/#ignite-scaffold-message) command accepts the message name as the first argument and a list of fields for the message.
- The [`ignite scaffold message`](/cli#ignite-scaffold-message) command accepts the message name as the first argument and a list of fields for the message.
- By default, a message is scaffolded in a module with a name that matches the name of the project, in this case `nameservice`.

### Add the MsgBuyName Message
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Now that you've defined messages that trigger state transitions, it's time to im
For the nameservice blockchain, define a `whois` type and the create and delete methods.

Because Ignite CLI does the heavy lifting for you, choose from several [ignite scaffold](https://docs.ignite.com/cli#ignite-scaffold) commands to create CRUD functionality code for data stored in different ways:
Because Ignite CLI does the heavy lifting for you, choose from several [ignite scaffold](/cli#ignite-scaffold) commands to create CRUD functionality code for data stored in different ways:

- Array, a list-like data structure
- Map (key-value pairs)
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.25.2/guide/06-loan.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Use the `--dep` flag to specify that this module depends on and is going to inte

## Scaffold a list

Use the [scaffold list](https://docs.ignite.com/cli#ignite-scaffold-list) command to scaffold code necessary to store loans in an array-like data structure:
Use the [scaffold list](/cli#ignite-scaffold-list) command to scaffold code necessary to store loans in an array-like data structure:

```bash
ignite scaffold list loan amount fee collateral deadline state borrower lender --no-message
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.25.2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Many projects already showcase the Tendermint BFT consensus engine and the Cosmo
## Projects building with Ignite CLI

* [Sifchain: omni-chain solution for DEXs](https://github.com/Sifchain/sifnode)
* [Kyve](https://www.kyve.network/)
* [Kyve](https://www.kyve.network)
* [crypto.org chain](https://github.com/crypto-org-chain/chain-main) ([initialized with Ignite CLI](https://github.com/crypto-org-chain/chain-main/commit/37b2ecb49a9aae7c581270a4f2dbecfcd8e8a6e9))
* [Cronos](https://github.com/crypto-org-chain/cronos)
* [Plugchain](https://github.com/oracleNetworkProtocol/plugchain)
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.25.2/kb/00-kb.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ slug: /kb

Knowledge base articles cover different aspects of Ignite CLI. This online library includes reference content on supported types, protocol buffer files, chain simulation as well as an overview of scaffolding a chain all the way to starting an IBC relayer.

If you're new to Ignite CLI or want to go through a series of tutorials, visit the [Developer Tutorials](https://docs.ignite.com/guide).
If you're new to Ignite CLI or want to go through a series of tutorials, visit the [Developer Tutorials](/guide).
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.25.2/kb/07-frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ client:
path: "vue/src/store"
```
A TS client is generated in the `ts-client` directory (see: [TypeScript client information](https://docs.ignite.com/clients/typescript)) and Vuex store modules making use of this client are generated in the `vue/src/store` directory.
A TS client is generated in the `ts-client` directory (see: [TypeScript client information](/clients/typescript)) and Vuex store modules making use of this client are generated in the `vue/src/store` directory.

## Client code regeneration

Expand Down
2 changes: 1 addition & 1 deletion ignite/cmd/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ func checkNewVersion(ctx context.Context) {
fmt.Printf(
· 🛸 Ignite CLI %s is available!
·
· To upgrade your Ignite CLI version, see the upgrade doc: https://docs.ignite.com/guide/install.html#upgrading-your-ignite-cli-installation
· To upgrade your Ignite CLI version, see the upgrade doc: https://docs.ignite.com/guide/install#upgrading-your-ignite-cli-installation
·
··
Expand Down
Loading

0 comments on commit a645f1e

Please sign in to comment.