Content-Length: 283775 | pFad | http://github.com/electric-sql/electric/pull/2731

98 docs: replace source_secret with secret by balegas · Pull Request #2731 · electric-sql/electric · GitHub
Skip to content

docs: replace source_secret with secret #2731

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

balegas
Copy link
Contributor

@balegas balegas commented May 17, 2025

Since our Cloud accepts the query param secret, we should just remove mentions to the legacy source_secret in our docs. See #2729 for context.

@balegas balegas requested review from Copilot and thruflo May 17, 2025 15:04
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates documentation and examples to replace the legacy source_secret parameter with the new secret parameter, aligning with the Cloud API’s current query parameter.

  • Renames all occurrences of source_secret to secret in CURL examples and TypeScript snippets
  • Updates descriptive text to reflect the new secret parameter usage
Comments suppressed due to low confidence (2)

website/product/cloud.md:90

  • [nitpick] The environment variable SECRET is very generic and could collide with other secrets. Consider renaming it to something more specific like ELECTRIC_SECRET or CLOUD_SECRET for clarity.
&secret=$SECRET"

website/product/cloud.md:139

  • [nitpick] Mixing backticks for static string literals can be confusing; consider using single or double quotes ('secret' or "secret") for consistency with the rest of the codebase.
origenUrl.searchParams.set(`secret`, process.env.SECRET)

Copy link

netlify bot commented May 17, 2025

Deploy Preview for electric-next ready!

Name Link
🔨 Latest commit 2cb4b68
🔍 Latest deploy log https://app.netlify.com/projects/electric-next/deploys/6828a57928cefc00089dce49
😎 Deploy Preview https://deploy-preview-2731--electric-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/electric-sql/electric/pull/2731

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy