docs: Better link language SDKs #6866
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
The SDK support is there for many languages now and these are likely a preferred way to use OPA's REST API for many application developers. This PR adds some links to make sure these are featured in suitable locations so they are not missed as people browse the docs. Signed-off-by: Charlie Egan <charlie@styra.com>
✅ Deploy Preview for openpolicyagent ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
chendrix
suggested changes
Jul 9, 2024
docs/content/integration.md
Outdated
| When your application or service needs to make policy decisions it can query OPA | ||
| locally via HTTP. While it's possible to call OPA's [REST API](../rest-api) directly, | ||
| you can also find a number of [native language REST SDKs](/ecosystem/#languages) | ||
| eoo which make the integration easier. |
There was a problem hiding this comment.
😬 not sure what that one was meant to be...
docs/content/rest-api.md
Outdated
| OPA integration using one of the [language SDKs](/ecosystem/#languages) than working | ||
| with the REST API directly. | ||
| {{< /info >}} | ||
|
|
There was a problem hiding this comment.
I find this note a bit misplaced. I mean we're on the rest api page and right at the top we're hinting that this approach may not be ideal. I would rather have this somewhere in the text later on or at the end imo.
There was a problem hiding this comment.
The point is to ensure that users are aware that they dont have to deal with the REST API unless they need to.
There was a problem hiding this comment.
I've opted to move this down to the end of the intro, it still features prominently above the fold.
ashutosh-narkar
previously approved these changes
Jul 9, 2024
Signed-off-by: Charlie Egan <charlie@styra.com>
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.
The SDK support is there for many languages now and these are likely a preferred way to use OPA's REST API for many application developers.
This PR adds some links to make sure these are featured in suitable locations so they are not missed as people browse the docs.