Skip to content

docs(backend): fix dead links in the plugin development manual - #9407

Open
farisbasha wants to merge 1 commit into
apache:mainfrom
farisbasha:docs-fix-dev-manual-links
Open

farisbasha wants to merge 1 commit into
apache:mainfrom
farisbasha:docs-fix-dev-manual-links

Conversation

@farisbasha

Copy link
Copy Markdown

⚠️ Pre Checklist

  • I have read through the Contributing Documentation.
  • I have added relevant tests. (docs-only change)
  • I have added relevant documentation.
  • I will add labels to the PR, such as pr-type/bug-fix, pr-type/feature-development, etc. (I don't have permission to add labels; pr-type/docs would fit)

Summary

Fixes dead links in backend/DevelopmentManual.md and backend/python/README.md:

  • The GitLab plugin API example links point to api/connection.go, api/scope.go, api/scope_config.go and api/remote.go. These files are now named connection_api.go, scope_api.go, scope_config_api.go and remote_api.go, so all four links returned 404.
  • The domain layer schema links use /docs/next/DataModels/DevLakeDomainLayerSchema/, which returns 404. The page is at https://devlake.apache.org/docs/DataModels/DevLakeDomainLayerSchema/.

I checked every new URL with curl -sI (no redirect following): all return 200.

Does this close any open issues?

No.

Other Information

I used an AI assistant to help find these links.

The GitLab plugin API files were renamed to *_api.go, so the example
links for connections, scopes, scope configs and remote scopes return
404. The domain layer schema page is no longer served under
/docs/next/. Point the links at the current locations.

@klesh klesh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good catch.
Thanks for your contribution

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