[
https://issues.apache.org/jira/browse/IGNITE-6065?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16178550#comment-16178550
]
Ilya Borisov edited comment on IGNITE-6065 at 9/25/17 5:34 AM:
---------------------------------------------------------------
I've decided to go with a script instead of a unit test because it was easier
to implement and won't require any additional changes to CI setup. You have to
run it manually from _modules/webconsole/frontend/scripts/check-doc-links_. Run
with _--help_ parameter for usage info. The script requires at least Node.js
8.5.0.
Output example:
{code}
> node scripts\check-doc-links.js
Looking for invalid apacheignite.readme.io domain doc links in
./{app,views}/**/*.pug.
Checking links [===================================] 35/35
Total links: 35
Invalid links found: 1
1. https://apacheignite.readme.io/docsss/data-grid in
./app/modules/states/configuration/caches/general.pug
{code}
[~kuaw26] please review.
was (Author: klaster_1):
I've decided to go with a script instead of a unit test because it was easier
to implement and won't require any additional changes to CI setup. You have to
run it manually from _modules/webconsole/frontend/scripts/check-doc-links_. Run
with _--help_ parameter for usage info.
Output example:
{code}
> node scripts\check-doc-links.js
Looking for invalid apacheignite.readme.io domain doc links in
./{app,views}/**/*.pug.
Checking links [===================================] 35/35
Total links: 35
Invalid links found: 1
1. https://apacheignite.readme.io/docsss/data-grid in
./app/modules/states/configuration/caches/general.pug
{code}
[~kuaw26] please review.
> Quick way to find broken documentation links
> --------------------------------------------
>
> Key: IGNITE-6065
> URL: https://issues.apache.org/jira/browse/IGNITE-6065
> Project: Ignite
> Issue Type: Test
> Components: UI, wizards
> Reporter: Ilya Borisov
> Assignee: Ilya Borisov
> Priority: Minor
> Attachments: configuration more info link.PNG
>
>
> Documentation links break from time to time. We need a tool that walks all
> links and reports anything we might want to fix. Since all links are in .pug
> templates, I suggest to use pug-walk from standard pug package.
> The tool should:
> 1. Provide a way to change location of pug files and docs domain name
> (apacheignite.readme.io by default).
> 2. If invalid link are found, output a list of link / pug path.
> 3. Provide usage info in some way (readme or --help argument).
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
