docs: allow configuration of generated OpenTelemetry documentation path#410
Merged
docs: allow configuration of generated OpenTelemetry documentation path#410
Conversation
0201516 to
9949e58
Compare
4 tasks
jimmyjames
approved these changes
Aug 20, 2024
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 pull request replaces the
supportsOpenTelemetryconfiguration override with aopenTelemetryDocumentationvariable. This enables us to change the link/path used in the README to the OpenTelemetry documentation in a manner appropriate to the standards of the target programming language (for example, pascal for Java, snake for Python, etc.)As an example, in Java's case, it is preferable to output the OpenTelemetry documentation to https://github.com/openfga/java-sdk/blob/main/docs/OpenTelemetry.md instead of https://github.com/openfga/java-sdk/blob/main/docs/opentelemetry.md, as the casing for all the other generated documentation uses pascal case.
This change updates the base README template to point to the configured filename, rather than the generic
opentelemetry.mdfilename.References
Review Checklist
main