Skip to content

docs: allow configuration of generated OpenTelemetry documentation path#410

Merged
evansims merged 1 commit intomainfrom
docs/configurable-otel-filename
Aug 20, 2024
Merged

docs: allow configuration of generated OpenTelemetry documentation path#410
evansims merged 1 commit intomainfrom
docs/configurable-otel-filename

Conversation

@evansims
Copy link
Copy Markdown
Contributor

Description

This pull request replaces the supportsOpenTelemetry configuration override with a openTelemetryDocumentation variable. 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.md filename.

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

@evansims evansims added the documentation Improvements or additions to documentation label Aug 20, 2024
@evansims evansims force-pushed the docs/configurable-otel-filename branch from 0201516 to 9949e58 Compare August 20, 2024 21:06
@evansims evansims marked this pull request as ready for review August 20, 2024 21:09
@evansims evansims requested a review from a team as a code owner August 20, 2024 21:09
@evansims evansims enabled auto-merge August 20, 2024 21:10
@evansims evansims added this pull request to the merge queue Aug 20, 2024
Merged via the queue into main with commit 061a4aa Aug 20, 2024
@evansims evansims deleted the docs/configurable-otel-filename branch August 20, 2024 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants