Link external documentation and render description as markdown #24
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
|
@jeffersongirao Thanks 🙏 will have a look at this over the weekend. Btw totally agree as I created stoplightio/spectral#2443 😉 |
dweber019
approved these changes
Jun 8, 2024
There was a problem hiding this comment.
Expect from linting and a changeset every looks good.
https://github.com/dweber019/backstage-plugins/blob/main/CONTRIBUTING.md#creating-changesets
|
@dweber019 thanks for the quick reply! I've just added the changeset 👍. |
|
@jeffersongirao Should be available in a few minutes. |
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.
Hey there @dweber019!
Thanks a lot for your work on the Spectral Lint Plugin for Backstage! 🙌
In this PR I'm proposing to render a documentation URL link when that is available. Also to render the description as markdown (I think that is how some rules are documented out there, the spotlight one was added as an example).
Please let me know your thoughts on that! 🙂