Skip to content

[Merged by Bors] - Fix broken link to PBR example in README.md#2064

Closed
FlyingRatBull wants to merge 2 commits intobevyengine:mainfrom
FlyingRatBull:patch-2
Closed

[Merged by Bors] - Fix broken link to PBR example in README.md#2064
FlyingRatBull wants to merge 2 commits intobevyengine:mainfrom
FlyingRatBull:patch-2

Conversation

@FlyingRatBull
Copy link
Copy Markdown
Contributor

No description provided.

@mockersf mockersf added C-Examples An addition or correction to our examples S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels May 1, 2021
@mockersf
Copy link
Copy Markdown
Member

mockersf commented May 1, 2021

could you do that PR on branch main instead of latest?

@FlyingRatBull FlyingRatBull changed the base branch from latest to main May 1, 2021 11:34
@cart
Copy link
Copy Markdown
Member

cart commented May 1, 2021

bors r+

bors bot pushed a commit that referenced this pull request May 1, 2021
@bors
Copy link
Copy Markdown
Contributor

bors bot commented May 1, 2021

@bors bors bot changed the title Fix broken link to PBR example in README.md [Merged by Bors] - Fix broken link to PBR example in README.md May 1, 2021
@bors bors bot closed this May 1, 2021
@FlyingRatBull FlyingRatBull deleted the patch-2 branch May 1, 2021 19:15
FlyingRatBull added a commit to FlyingRatBull/bevy that referenced this pull request May 1, 2021
bors bot pushed a commit that referenced this pull request May 2, 2021
Adds an GitHub Action to check all local (non http://, https:// ) links in all Markdown files of the repository for liveness.
Fails if a file is not found.

# Goal
This should help maintaining the quality of the documentation.

# Impact
Takes ~24 seconds currently and found 3 dead links (pull requests already created).

# Dependent PRs
* #2064 
* #2065 
* #2066

# Info
See [markdown-link-check](https://github.com/marketplace/actions/markdown-link-check).

# Example output
```
FILE: ./docs/profiling.md

1 links checked.

FILE: ./docs/plugins_guidelines.md

37 links checked.

FILE: ./docs/linters.md
[✖] ../.github/linters/markdown-lint.yml → Status: 400 [Error: ENOENT: no such file or directory, access '/github/workspace/.github/linters/markdown-lint.yml'] {
  errno: -2,
  code: 'ENOENT',
  syscall: 'access',
  path: '/github/workspace/.github/linters/markdown-lint.yml'
}
```

# Improvements
* Can also be used to check external links, but fails because of:
  * Too many requests (429) responses:
```
FILE: ./CHANGELOG.md
[✖] #1762 → Status: 429
```
   * crates.io links respond 404
```
FILE: ./README.md
[✖] https://crates.io/crates/bevy → Status: 404
```
ostwilkens pushed a commit to ostwilkens/bevy that referenced this pull request Jul 27, 2021
ostwilkens pushed a commit to ostwilkens/bevy that referenced this pull request Jul 27, 2021
Adds an GitHub Action to check all local (non http://, https:// ) links in all Markdown files of the repository for liveness.
Fails if a file is not found.

# Goal
This should help maintaining the quality of the documentation.

# Impact
Takes ~24 seconds currently and found 3 dead links (pull requests already created).

# Dependent PRs
* bevyengine#2064 
* bevyengine#2065 
* bevyengine#2066

# Info
See [markdown-link-check](https://github.com/marketplace/actions/markdown-link-check).

# Example output
```
FILE: ./docs/profiling.md

1 links checked.

FILE: ./docs/plugins_guidelines.md

37 links checked.

FILE: ./docs/linters.md
[✖] ../.github/linters/markdown-lint.yml → Status: 400 [Error: ENOENT: no such file or directory, access '/github/workspace/.github/linters/markdown-lint.yml'] {
  errno: -2,
  code: 'ENOENT',
  syscall: 'access',
  path: '/github/workspace/.github/linters/markdown-lint.yml'
}
```

# Improvements
* Can also be used to check external links, but fails because of:
  * Too many requests (429) responses:
```
FILE: ./CHANGELOG.md
[✖] bevyengine#1762 → Status: 429
```
   * crates.io links respond 404
```
FILE: ./README.md
[✖] https://crates.io/crates/bevy → Status: 404
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-Examples An addition or correction to our examples S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants