Chore: Add OpenReplay to docs #828
Open
+128
−0
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
Adds OpenReplay to docs using the React package and instructions from their site. I used Varun's console code as inspiration, but tweaked things to our needs with Docusaurus. Notably: - Adding envs to the `docusaurus.config.ts` - Passing them directly to the `initOpenReplay` function instead of as args - Calling both the initialization and starting functions as `useEffect()` with their own depdencies. I wasn't able to see my sessions in the OpenReplay console, but I'm imagining that's because we've disabled those? Either way, when testing locally, I received a `200` from `<OUR INGEST ADDRESS>/v1/web/start` Before merging, we'll need to add the envs as key-values for GCP: - OPENRELAY_INGEST_POINT - OPENRELAY_PROJECT_KEY
|
@robertjdominguez Thanks for your PR! I've assigned @robertjdominguez to review it. |
Deploying ddn-docs with
|
| Latest commit: |
a44330f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8c777b9f.v3-docs-eny.pages.dev |
| Branch Preview URL: | https://rob-chore-add-openreplay.v3-docs-eny.pages.dev |
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 📝
Adds OpenReplay to docs using the React package and instructions from their site.
I used Varun's console code as inspiration but tweaked things to our needs with Docusaurus. Notably:
docusaurus.config.tsinitOpenReplayfunction instead of as argsuseEffect()with their own depdencies.I wasn't able to see my sessions in the OpenReplay console, but I imagine that's because we've disabled those for
localhost. Either way, when testing locally, I received a200from<OUR INGEST ADDRESS>/v1/web/startBefore merging, we'll need to add the envs as key-values for GCP:
OPENREPLAY_INGEST_POINTOPENREPLAY_PROJECT_KEY