Skip to content
New issue

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

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

Already on GitHub? # to your account

Introduce link checker #24

Open
valfirst opened this issue Jan 14, 2022 · 2 comments
Open

Introduce link checker #24

valfirst opened this issue Jan 14, 2022 · 2 comments

Comments

@valfirst valfirst transferred this issue from vividus-framework/vividus May 14, 2022
@valfirst valfirst changed the title [Docs] Introduce link checker Introduce link checker May 14, 2022
@valfirst
Copy link
Contributor Author

valfirst commented May 14, 2022

Starting from Antora 3 all invalid internal references are logged:

[14:22:41.467] ERROR (asciidoctor): target of include not found: partial$azure-authentication-invalid.adoc
    file: /.../vividus/docs/modules/plugins/pages/plugin-azure-resource-manager.adoc:18
    source: /.../vividus (refname: add-ability-to-exeute-azure-operations <worktree>, start path: docs)
[14:22:41.478] ERROR (asciidoctor): target of xref not found: commons:variables-more-invalid.adoc#_scopes
    file: /.../vividus/docs/modules/plugins/pages/plugin-azure-resource-manager.adoc
    source: /.../vividus (refname: add-ability-to-exeute-azure-operations <worktree>, start path: docs)

@valfirst
Copy link
Contributor Author

#25 adds the validation of all internal links. The validation of external links should be done using the same tool, but it should be run by schedule: once a week on Saturday morning

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant