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

Update payment.md code sample to require ./index.js #4256

Merged
merged 3 commits into from
Jun 14, 2024

Conversation

marleypowell
Copy link
Contributor

@marleypowell marleypowell commented Apr 5, 2024

The description paragraph mentions:

It then requires your app at ./index.js to start it up once the SDK is initialized.

https://github.com/open-telemetry/opentelemetry.io/blob/9b9596e21766406b0d93b203fd1bf184f831111e/content/en/docs/demo/services/payment.md?plain=1#L21C1-L25C24

This seems to be missing from the code sample.

@marleypowell marleypowell requested review from a team as code owners April 5, 2024 08:02
Copy link

linux-foundation-easycla bot commented Apr 5, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: marleypowell / name: Marley (a9cc4ee, 987d251)
  • ✅ login: svrnm / name: Severin Neumann (cc9381c)

Copy link
Member

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

@open-telemetry/demo-approvers PTAL

@svrnm svrnm added the sig:demo label Apr 8, 2024
@puckpuck
Copy link
Contributor

puckpuck commented Apr 9, 2024

This is not correct. What is missing is how you require this, which is done as part of the node command to start the app itself.

node --require ./opentelemetry.js index.js

@marleypowell
Copy link
Contributor Author

This is not correct. What is missing is how you require this, which is done as part of the node command to start the app itself.

node --require ./opentelemetry.js index.js

What would it look like in the Dockerfile?
image

@puckpuck
Copy link
Contributor

ENTRYPOINT [ "node", "--require", "./opentelemetry.js", "./index.js" ]

@svrnm
Copy link
Member

svrnm commented May 2, 2024

@marleypowell @open-telemetry/demo-approvers any more updates on this PR?

@svrnm svrnm added the sig-approval-missing Co-owning SIG didn't provide an approval label May 2, 2024
@svrnm
Copy link
Member

svrnm commented Jun 11, 2024

@marleypowell @open-telemetry/demo-approvers PTAL

@puckpuck
Copy link
Contributor

This PR in its current form, is not correct. The docs today are also not correct. See this comment on what the proper solution is, which would also require rewriting the paragraph description on the docs page: #4256 (comment)

The description paragraph mentions:
> It then requires your app at ./index.js to start it up once the SDK is initialized.

This seems to be missing from the code sample.
@svrnm
Copy link
Member

svrnm commented Jun 12, 2024

This PR in its current form, is not correct. The docs today are also not correct. See this comment on what the proper solution is, which would also require rewriting the paragraph description on the docs page: #4256 (comment)

thanks. @marleypowell can you fix the PR accordingly?

@marleypowell
Copy link
Contributor Author

This PR in its current form, is not correct. The docs today are also not correct. See this comment on what the proper solution is, which would also require rewriting the paragraph description on the docs page: #4256 (comment)

thanks. @marleypowell can you fix the PR accordingly?

I've updated it based on the suggestion 🙂

@svrnm svrnm merged commit 591af84 into open-telemetry:main Jun 14, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sig:demo sig-approval-missing Co-owning SIG didn't provide an approval
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants