docs: Add vscode documentation in main retina repo. #1326
Merged
Conversation
This file contains 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
Tatsinnit
force-pushed
the
add/retina-doc
branch
2 times, most recently
from
cccd175 to
b54a492
Compare
Tatsinnit
changed the title
Tatsinnit
force-pushed
the
add/retina-doc
branch
from
b54a492 to
2a159a0
Compare
Tatsinnit
force-pushed
the
add/retina-doc
branch
from
2a159a0 to
c1ace6b
Compare
7 tasks
kamilprz
reviewed
Feb 10, 2025
kamilprz
approved these changes
Feb 10, 2025
github-merge-queue bot
pushed a commit
that referenced
this pull request
Feb 10, 2025
# Description Hiya, while doing #1326, I've noticed that the document link is not working. this PR is made with an intent to fix that. You can see working `Captures` here - * https://github.com/Tatsinnit/retina/tree/fix/doclink?tab=readme-ov-file whereas the main repo has broken link for `captueres` which goes to page not found. ## Checklist - [x] I have read the [contributing documentation](https://retina.sh/docs/contributing). - [x] I signed and signed-off the commits (`git commit -S -s ...`). See [this documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) on signing commits. - [x] I have correctly attributed the author(s) of the code. - [x] I have tested the changes locally. - [x] I have followed the project's style guidelines. - [x] I have updated the documentation, if necessary. - [ ] I have added tests, if applicable. ## Screenshot: <img width="1456" alt="Screenshot 2025-02-10 at 8 38 19 AM" src="https://github.com/user-attachments/assets/4a5c1974-1882-46f7-856a-ff6de87fe77b" /> --- Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more information on how to contribute to this project.
7 tasks
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.
Documentation: Retina Integration in AKS VS Code Extension
This PR adds documentation for the integration of Retina in the AKS VS Code Extension. It provides an overview of how Retina enhances the extension's capabilities, enabling seamless capture and visualization of cluster telemetry. This PR should suffice: #274
I am open to any suggestions as well please, the reason I moved contribution down is because its a standard practices to keep that way, thanks!
Additionally, it includes a reference to the official Retina feature page: Retina Capture in AKS VS Code Extension.
Changes Included:
This update aims to improve discoverability and provide users with a clear understanding of how to leverage Retina within their AKS development workflow.
Checklist
git commit -S -s ...). See this documentation on signing commits.Screenshots (if applicable) or Testing Completed