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

Use absolute URLs for failing links in docs/index.md #331

Merged
merged 1 commit into from
Jan 3, 2025

Conversation

pankajkoti
Copy link
Contributor

@pankajkoti pankajkoti commented Jan 3, 2025

When running hatch run docs:build locally, warnings are reported indicating that the linked pages for LICENSE and PRIVACY_NOTICE cannot be found. This occurs because those GitHub pages are outside the context of the built and shipped documentation, leading to errors when clicking those links. To address this, I am updating the links to use absolute GitHub URLs to correctly locate these files.

The warning message is as below:

INFO    -  Building documentation to directory: /Users/pankajkoti/astronomer/dag-factory/site
INFO    -  Doc file 'index.md' contains an unrecognized relative link '../LICENSE', it was left as is.
WARNING -  Doc file 'index.md' contains a link '../PRIVACY_NOTICE.md', but the target is not found among documentation files.

And clicking on those links in the served docs, gives an error as shown in below screenshot:
Screenshot 2025-01-03 at 12 00 29 PM

@codecov-commenter
Copy link

codecov-commenter commented Jan 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.31%. Comparing base (a53c765) to head (f9922c3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #331   +/-   ##
=======================================
  Coverage   93.31%   93.31%           
=======================================
  Files          10       10           
  Lines         778      778           
=======================================
  Hits          726      726           
  Misses         52       52           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pankajkoti pankajkoti marked this pull request as ready for review January 3, 2025 06:32
@pankajkoti pankajkoti requested a review from a team as a code owner January 3, 2025 06:32
@pankajkoti pankajkoti merged commit e9f9929 into main Jan 3, 2025
67 checks passed
@pankajkoti pankajkoti deleted the correct-links-in-docs branch January 3, 2025 06:50
@pankajastro pankajastro added this to the DAG Factory 0.22.0 milestone Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants