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.

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

Fix unrecognized relative links in the docs and GitHub Actions workflow to validate building the documentation (Lombiq Technologies: OCORE-155) #15695

Merged
merged 36 commits into from
Apr 23, 2024

Conversation

Piedone
Copy link
Member

@Piedone Piedone commented Apr 9, 2024

When you run mkdocs serve to run the documentation site locally, previously you got the below warnings. I fixed the links, and removed outdated ones where applicable.

I also added a GitHub Actions workflow to validate building the documentation to prevent further such issues.

INFO    -  Doc file 'docs/guides/create-modular-application-mvc/README.md' contains an unrecognized relative link
           '../../getting-started/templates/', it was left as is. Did you mean
           '../../getting-started/templates/README.md'?
INFO    -  Doc file 'docs/reference/modules/Media/README.md' contains an unrecognized relative link
           '../../../getting-started/preview-package-source', it was left as is. Did you mean
           '../../../getting-started/preview-package-source.md'?
INFO    -  Doc file 'docs/reference/modules/Media/README.md' contains an unrecognized relative link
           '../../../getting-started/preview-package-source', it was left as is. Did you mean
           '../../../getting-started/preview-package-source.md'?
INFO    -  Doc file 'docs/reference/modules/Media/README.md' contains an unrecognized relative link
           '../../../getting-started/preview-package-source', it was left as is. Did you mean
           '../../../getting-started/preview-package-source.md'?
INFO    -  Doc file 'docs/reference/modules/Scripting/README.md' contains an unrecognized relative link
           '../Setup/#recipe-parameters', it was left as is. Did you mean '../Setup/README.md#recipe-parameters'?
INFO    -  Doc file 'docs/reference/modules/Seo/README.md' contains an unrecognized relative link '../Sitemaps', it was
           left as is. Did you mean '../Sitemaps/README.md'?
INFO    -  Doc file 'docs/reference/modules/Seo/README.md' contains an unrecognized relative link
           '../Tenants/#static-file-provider-feature', it was left as is. Did you mean
           '../Tenants/README.md#static-file-provider-feature'?
INFO    -  Doc file 'docs/reference/modules/Shortcodes/README.md' contains an unrecognized relative link '../Liquid/',
           it was left as is. Did you mean '../Liquid/README.md'?
INFO    -  Doc file 'docs/reference/modules/Shortcodes/README.md' contains an unrecognized relative link
           '../../../getting-started/preview-package-source', it was left as is. Did you mean
           '../../../getting-started/preview-package-source.md'?
INFO    -  Doc file 'docs/reference/modules/Templates/README.md' contains an unrecognized relative link
           '../../core/Placement/', it was left as is. Did you mean '../../core/Placement/README.md'?
INFO    -  Doc file 'docs/reference/modules/Workflows/README.md' contains an unrecognized relative link
           '../Queries/#scripting', it was left as is. Did you mean '../Queries/README.md#scripting'?
INFO    -  Doc file 'docs/releases/1.7.0.md' contains an unrecognized relative link '../modules/Sitemaps', it was left
           as is.
INFO    -  Doc file 'docs/resources/README.md' contains an unrecognized relative link 'tutorials', it was left as is.
           Did you mean 'tutorials/README.md'?
INFO    -  Doc file 'docs/resources/README.md' contains an unrecognized relative link 'development-tools', it was left
           as is. Did you mean 'development-tools/README.md'?
INFO    -  Doc file 'docs/resources/README.md' contains an unrecognized relative link 'meeting', it was left as is. Did
           you mean 'meeting/README.md'?
INFO    -  Doc file 'docs/resources/README.md' contains an unrecognized relative link 'branding', it was left as is. Did
           you mean 'branding/README.md'?
INFO    -  Doc file 'docs/resources/README.md' contains an unrecognized relative link 'libraries', it was left as is.
           Did you mean 'libraries/README.md'?
INFO    -  Doc file 'docs/resources/README.md' contains an unrecognized relative link 'owners', it was left as is. Did
           you mean 'owners/README.md'?
INFO    -  Doc file 'docs/resources/README.md' contains an unrecognized relative link 'workshops', it was left as is.
           Did you mean 'workshops/README.md'?
INFO    -  Doc file 'docs/topics/configuration/README.md' contains an unrecognized relative link '../glossary/#Recipe',
           it was left as is.
INFO    -  Doc file 'docs/topics/configuration/README.md' contains an unrecognized relative link '../glossary/#Tenant',
           it was left as is.

@Piedone Piedone requested a review from agriffard as a code owner April 9, 2024 00:55
@Piedone
Copy link
Member Author

Piedone commented Apr 15, 2024

@agriffard can you please review?

@Piedone Piedone requested a review from hishamco April 22, 2024 22:03
@Piedone Piedone changed the title Fix unrecognized relative links in the docs (Lombiq Technologies: OCORE-155) Fix unrecognized relative links in the docs and GitHub Actions workflow to validate building the documentation (Lombiq Technologies: OCORE-155) Apr 23, 2024
Copy link
Member

@MikeAlhayek MikeAlhayek left a comment

Choose a reason for hiding this comment

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

I like this to ensure our docs do not have invalid links

@MikeAlhayek MikeAlhayek merged commit 05bc02b into OrchardCMS:main Apr 23, 2024
6 checks passed
@Piedone
Copy link
Member Author

Piedone commented Apr 23, 2024

Thank you!

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

Successfully merging this pull request may close these issues.

2 participants