Skip to content

Add documentation for proxy configuration and connection setup #340

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

Add documentation for proxy configuration and connection setup #340

wants to merge 2 commits into from

Conversation

beltagymohamed
Copy link

Description

Since Unleash chose not to add this information to their website, I have included it directly in the repository documentation instead.
#338

  • Clarified the process of running the proxy container with the experimental feature EXP_SERVER_SIDE_SDK_CONFIG_TOKENS.
  • Added instructions for replacing placeholders with actual values.
  • Provided clear code examples for both running the proxy and connecting to it.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

  • Manual Tests: Verified that the updated documentation correctly explains the setup process and is easy to follow. All examples were tested manually for accuracy.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@beltagymohamed
Add documentation for proxy configuration and connection setup
7955ac9 
- Clarified the process of running the proxy container with the experimental feature `EXP_SERVER_SIDE_SDK_CONFIG_TOKENS`.
- Added instructions for replacing placeholders with actual values.
- Provided clear code examples for both running the proxy and connecting to it.
@beltagymohamed beltagymohamed mentioned this pull request Jan 9, 2025
Closed
13 tasks
@coveralls
Copy link

Coverage Status

coverage: 95.316%. remained the same
when pulling ca38a84 on beltagymohamed:patch-2
into b46cd17 on Unleash:main.

@coveralls
Copy link

Coverage Status

coverage: 95.316%. remained the same
when pulling ca38a84 on beltagymohamed:patch-2
into b46cd17 on Unleash:main.

@FredrikOseberg
Copy link
Collaborator

@beltagymohamed

I'd rather not add this documentation to the actual SDK repositories because we are trying to keep them aligned in terms of documentation and that would mean that we would have to add implementation specifics for the proxy in our other SDKs. I think this is something that may belong in the unleash-proxy repository itself.

Feel free to open a PR there with this content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FredrikOseberg FredrikOseberg Awaiting requested review from FredrikOseberg

Assignees
No one assigned
Labels
None yet
Projects
Issues and PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@beltagymohamed @coveralls @FredrikOseberg