Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Erlang] RollDice-related doc improvements #4327

Merged

Conversation

apreifsteck
Copy link
Contributor

@apreifsteck apreifsteck commented Apr 19, 2024

Light edits to the documentation to streamline the getting started guide, and adds some tips and gotchas.

More details:

  • Fixes broken link pointing to the RollDice example project
  • Changes code examples to use RollDice instead of DiceGame (DiceGame outdated)
  • Explicitly adds in a few implied code changes in the getting started guide. It should be more copy-paste ready now.
  • Adds an in-line docker compose file and collector config to the exporting guide, for easy copy-pasta

Copy link

linux-foundation-easycla bot commented Apr 19, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: apreifsteck / name: Austin Reifsteck (bea0f17)
  • ✅ login: svrnm / name: Severin Neumann (a0f7839)

@theletterf
Copy link
Member

@apreifsteck Hi there! Could you please sign the CLA and add a bit of context in the description? Thanks!

@apreifsteck apreifsteck force-pushed the getting_started_documentation_update branch from c75672c to 1f2d834 Compare May 10, 2024 17:55
@apreifsteck apreifsteck changed the title wip Documentation tweaks Jun 7, 2024
@apreifsteck apreifsteck force-pushed the getting_started_documentation_update branch from b80d1ac to 4347eea Compare June 7, 2024 16:08
@apreifsteck apreifsteck marked this pull request as ready for review June 7, 2024 16:08
@apreifsteck apreifsteck requested review from a team as code owners June 7, 2024 16:08
@chalin chalin force-pushed the getting_started_documentation_update branch from 4347eea to 117ba21 Compare June 7, 2024 19:57
@chalin chalin changed the title Documentation tweaks [Erlang] RollDice-related doc improvements Jun 8, 2024
@chalin chalin force-pushed the getting_started_documentation_update branch from 117ba21 to 0a6a61f Compare June 8, 2024 09:42
@chalin
Copy link
Contributor

chalin commented Jun 8, 2024

Thanks for this @apreifsteck. I'll let @open-telemetry/erlang-approvers comment about the content.

Note that a few of the GitHub checks are failing. You'll need to pull this PR branch back down, rebase from main, and fix the issues. For guidance, see https://opentelemetry.io/docs/contributing/#fix-content-issues-automatically.

@@ -17,12 +17,18 @@ Add the following dependencies to your project:
- `opentelemetry`: contains the SDK that implements the interfaces defined in
the API. Without it, all the functions in the API are no-ops.

Optionally, you may choose to include the `open_telemetry_decorator` library.
Note that this library is not officially supported by the opentelemetry project,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be removed since not officially supported.

@tsloughter
Copy link
Member

Changes look ok and are important (module names are wrong currently) but one thing should be removed that I noted.

@apreifsteck apreifsteck force-pushed the getting_started_documentation_update branch from 1514190 to bea0f17 Compare June 8, 2024 20:26
@svrnm svrnm merged commit 65c06ed into open-telemetry:main Jun 10, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants