docs icon indicating copy to clipboard operation
docs copied to clipboard

Add tutorial to connect to neon

Open ananis25 opened this issue 10 months ago • 2 comments

📚 Context

This PR adds a tutorial in the database section on connecting to Neon databases. I work on technical content for Neon.

🧠 Description of Changes

Added a tutorial document and link to it from the databases page/sidebar.

  • content/develop/tutorials/databases/_index.md
  • content/develop/tutorials/databases/neon.md
  • content/menu.md

💥 Impact

Databases subsection in tutorials

Size:

  • [x] Small

🌐 References

Contribution License Agreement

By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

ananis25 avatar Apr 17 '24 19:04 ananis25

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
- PostgreSQL Credentials 26d4fccf82c47caa5a22fc42196e8330c3eb5d3e content/develop/tutorials/databases/neon.md View secret
- PostgreSQL Credentials fbcacf59ab2b7993e35ab99b16656bd172a46a99 content/develop/tutorials/databases/neon.md View secret
🛠 Guidelines to remediate hardcoded secrets

The above secret(s) have been detected in your PR. Please take an appropriate action for each secret:

  • If it’s a true positive, remove the secret from source code, revoke it and migrate to a secure way of storing and accessing secrets (see http://go/secrets-and-code). Once that’s done, go to the incidents page linked in the “GitGuardian id” column (log in using SnowBiz Okta) and resolve the incident.
  • If it’s a false positive, go to the incidents page linked in the “GitGuardian id” column (log in using SnowBiz Okta) and ignore the incident.
  • If you didn't add this secret - and only then - you may ignore this check as it's non-blocking. If you did add the secret and you ignore this check, you'll be assigned a "Security Finding" ticket in Jira in a few days.

Note:

  • A secret is considered leaked from the moment it touches GitHub. Rewriting git history by force pushing or other means is not necessary and doesn’t change the fact that the secret has to be revoked.
  • This check has a “Skip: false positive” button. Don’t use it. It will mark all detected secrets as false positives but only in the context of this specific run - it won’t remember this action in subsequent check runs.

If you encounter any problems you can reach out to us on Slack: #gitguardian-secret-scanning-help


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

gitguardian[bot] avatar Apr 17 '24 19:04 gitguardian[bot]

Hi @chaninn 👋, please let us know if we need to make any changes. 🙏

raoufchebri avatar May 01 '24 12:05 raoufchebri

Hi @ananis25 and @raoufchebri. I'll be taking a look at this. I've planned it for my current sprint and should be able to look at it this week, but since I'm new to neon I'm not 100% sure how much time it will take me to validate the tutorial before I get into it. If there are any issues, I'll comment on the PR, or just make the edits to commit it if they are minor.

sfc-gh-dmatthews avatar May 06 '24 14:05 sfc-gh-dmatthews

I matched the tutorial to a newer tutorial template. I'll give it a final proofread to check that I didn't introduce typos and commit it on Monday. :) Thanks for the contribution!

sfc-gh-dmatthews avatar May 11 '24 23:05 sfc-gh-dmatthews

Thank you @sfc-gh-dmatthews !

ananis25 avatar May 14 '24 05:05 ananis25