You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ignite.apache.org by "Ilya Borisov (JIRA)" <ji...@apache.org> on 2017/09/25 05:23:00 UTC
[jira] [Updated] (IGNITE-6065) Quick way to find broken
documentation links
[ https://issues.apache.org/jira/browse/IGNITE-6065?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Ilya Borisov updated IGNITE-6065:
---------------------------------
Description:
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).
was:Documentation links break from time to time. We need a special test 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.
> 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)