Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add markdown link check to precommit hooks #2319

Closed
wants to merge 6 commits into from
Closed

Add markdown link check to precommit hooks #2319

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d37620c
add link check to precommit hooks (will fail until we whitelist)
Jul 23, 2019
784673c
fix azure link
Jul 23, 2019
87404ec
fix imitation learning links
Jul 23, 2019
60bac7f
refer to non-localized docs
Jul 24, 2019
777dcd0
exclude localized and secure nvidia links
Jul 24, 2019
9799dc9
add comments
Jul 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,14 @@ repos:
.*_pb2.py|
.*_pb2_grpc.py
)$
# "Local" hooks, see https://pre-commit.com/#repository-local-hooks
- repo: local
hooks:
- id: markdown-link-check
name: markdown-link-check
entry: markdown-link-check
language: node
language_version: 12.6.0
types: [markdown]
additional_dependencies: ['[email protected]']
#args: [--verbose]
2 changes: 1 addition & 1 deletion docs/Training-PPO.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ Typical Range: `0.1` - `0.5`
### Demo Path

`demo_path` is the path to your `.demo` file or directory of `.demo` files.
See the [imitation learning guide](Training-ImitationLearning.md) for more on `.demo` files.
See the [imitation learning guide](Training-Imitation-Learning.md) for more on `.demo` files.

### Steps

Expand Down
2 changes: 1 addition & 1 deletion docs/Training-RewardSignals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Typical Range: `0.8` - `0.9`
#### Demo Path

`demo_path` is the path to your `.demo` file or directory of `.demo` files. See the [imitation learning guide]
(Training-ImitationLearning.md).
(Training-Imitation-Learning.md).

#### Encoding Size

Expand Down
2 changes: 1 addition & 1 deletion docs/Training-on-Microsoft-Azure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ support.

A pre-configured virtual machine image is available in the Azure Marketplace and
is nearly completely ready for training. You can start by deploying the
[Data Science Virtual Machine for Linux (Ubuntu)](https://azuremarketplace.microsoft.com/marketplace/apps/microsoft-ads.linux-data-science-vm-ubuntu)
[Data Science Virtual Machine for Linux (Ubuntu)](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/microsoft-dsvm.linux-data-science-vm-ubuntu)
into your Azure subscription. Once your VM is deployed, SSH into it and run the
following command to complete dependency installation:

Expand Down
8 changes: 4 additions & 4 deletions docs/localized/zh-CN/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ TensorFlow），让游戏开发者和业余爱好者能够轻松地
**除了安装和使用说明外，如需更多信息，
请参阅我们的[文档主页](docs/Readme.md)。**如果您使用的
是 v0.3 之前的 ML-Agents 版本，强烈建议您参考
我们的[关于迁移到 v0.3 的指南](/docs/Migrating.md)。
我们的[关于迁移到 v0.3 的指南](../../../docs/Migrating.md)。
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ervteng @unityjeffrey Let me know what you think about this - to "officially" get the link checker running, we need to have the links from the localized docs point somewhere, because they doc they do point to hasn't been localized. I figure this is better since it's at least explicit in the markdown that it's linking somewhere outside the localization.

Alternative is just whitelist the localized docs and skip the checks on then.


我们还发布了一系列与 ML-Agents 相关的博客文章：
- reinforcement learning（强化学习）概念概述
Expand All @@ -53,8 +53,8 @@ TensorFlow），让游戏开发者和业余爱好者能够轻松地

ML-Agents 是一个开源项目，我们鼓励并欢迎大家贡献自己的力量。
如果您想做出贡献，请务必查看我们的
[贡献准则](/CONTRIBUTING.md)和
[行为准则](/CODE_OF_CONDUCT.md)。
[贡献准则](../../../CONTRIBUTING.md)和
[行为准则](../../../CODE_OF_CONDUCT.md)。

您可以通过 Unity Connect 和 GitHub 与我们以及更广泛的社区进行交流：
* 加入我们的
Expand All @@ -71,4 +71,4 @@ ML-Agents 是一个开源项目，我们鼓励并欢迎大家贡献自己的力

## 许可证

[Apache 许可证 2.0](LICENSE)
[Apache 许可证 2.0](../../../LICENSE)