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

docs: Ruby tutorial #6753

Merged
merged 4 commits into from
Apr 4, 2024
Merged

docs: Ruby tutorial #6753

merged 4 commits into from
Apr 4, 2024

Conversation

alvinometric
Copy link
Contributor

A "getting started" for the Ruby SDK.

I used the Stars Wars API, in typical tutorial style.

Copy link

vercel bot commented Apr 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unleash-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 4, 2024 9:24am
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 4, 2024 9:24am

Copy link

@codescene-delta-analysis codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

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

Code Health Quality Gates: OK

  • Declining Code Health: 0 findings(s) 🚩
  • Improving Code Health: 0 findings(s) ✅
  • Affected Hotspots: 0 files(s) 🔥

Recommended Review Level: Detailed -- Increased risk for defects: The risk is higher as much of the code in this repo (99% of all commits) is written by other authors.
View detailed results in CodeScene

Copy link
Member

@sighphyre sighphyre left a comment

Choose a reason for hiding this comment

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

Very cool! Left some thoughts but I don't see anything blocking


Most importantly, you must:

- Limit feature flag payloads for scalability, security, and efficiency
Copy link
Member

Choose a reason for hiding this comment

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

This is a bit of a scary thing to say in a tutorial without qualifying it. I think this deserves a link to unpack that a bit more (or remove it?).

In practice, this is a problem if you have 1000+ constraints or an equivalent amount of toggles

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this calls for a review by engineers of this section of text that we are using across our documentation.
We aim to be as accurate as possible with this so thanks for this feedback. I'll post about it in engineering rotation.


## 4. Add the GraphQL endpoint

The point of this tutorial is to mimic a real-world scenario where, based on a feature flag, you would migrate from a REST API to GraphQL. So far, we’ve just used REST. Now, let’s add the GraphQL version. The GraphQL endpoint is `https://swapi-graphql.netlify.app/.netlify/functions/index`, which looks like someone’s weekend project but is an official endpoint [from Apollo](http://graphql.org/swapi-graphql).
Copy link
Member

Choose a reason for hiding this comment

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

"someone's weekend project" I lol'd :)

Co-authored-by: Simon Hornby <liquidwicked64@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants