docs(): fix dead links and update obsolete URLs in contributor docs#486
Open
Maximus-08 wants to merge 2 commits into
Open
docs(): fix dead links and update obsolete URLs in contributor docs#486Maximus-08 wants to merge 2 commits into
Maximus-08 wants to merge 2 commits into
Conversation
Signed-off-by: Avnish Jaltare <avnishjaltare8@gmail.com>
Maximus-08
requested review from
Rahul-D78,
bharath-avesha,
gourishkb and
richiesebastian
as code owners
Author
|
@gourishkb @Rahul-D78 PTAL whenever you are free. Thanks! |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates contributor/developer documentation to point to the newer Avesha docs site and to use repository-relative links for in-repo documents.
Changes:
- Updated external documentation links in the developer guide to new docs URLs.
- Switched Code of Conduct and developer guide links in CONTRIBUTING to relative paths.
- Updated Go coding guidelines link to the go.dev wiki.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| developer_guide.md | Updates external Avesha documentation links referenced by the developer guide. |
| CONTRIBUTING.md | Uses repo-relative links for in-repo docs and refreshes external guidance links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Avnish Jaltare <avnishjaltare8@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR resolves obsolete and dead URLs in the repository documentation to maintain correct link health.
CONTRIBUTING.md: Replaced dead branch URLs pointing to a non-existent remote branch with standard local relative links (code_of_conduct.mdanddeveloper_guide.md). Updated the Go coding guide URL.developer_guide.md: Updated obsoletedocs.avesha.io/opensource/links to active Avesha open-source v1.4.0 documentation paths (specifically/category/get-started/,/install-kubeslice/kubeslice-cli/install-kubeslice/, and/uninstall-kubeslice/). Left the detaching/deleting slice links unmodified although it still gives 404 as no replacement found on web.Fixes #
How Has This Been Tested?
Checked web to find these links hence they currently resolve.
Checklist:
go fmtDoes this PR introduce a breaking change?