From cd65d2709590ccc57b81c1f1f5e9e76e498a93bd Mon Sep 17 00:00:00 2001 From: Victor Petrovykh Date: Wed, 19 Feb 2025 17:07:29 -0500 Subject: [PATCH] Update README and CONTRIBUTING replacing Edgedb with Gel. --- CONTRIBUTING.rst | 20 ++++++------ README.md | 81 +++++++++++++++++++++++++----------------------- 2 files changed, 52 insertions(+), 49 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6ff912a33c7..96d7960e323 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,7 +1,7 @@ -How to contribute to EdgeDB -=========================== +How to contribute to Gel +======================== -Thank you for contributing to EdgeDB! We love our open source community and +Thank you for contributing to Gel! We love our open source community and want to foster a healthy contributor ecosystem. To make sure the project can continue to improve quickly, we have a few @@ -55,8 +55,8 @@ Contributing documentation possible without being bogged down by other changes that require more intensive review. -Please see EdgeDB's guide for `building documentation -`_ from +Please see Gel's guide for `building documentation +`_ from source. Documentation style @@ -69,8 +69,8 @@ Documentation style that in favor of ``*param*``, in order to distinguish between parameter references and inline code (which *should* be surrounded by double backticks). -- **EdgeDB is singular.** Choose "EdgeDB is" over "EdgeDB are" and "EdgeDB - does" over "EdgeDB do." +- **Gel is singular.** Choose "Gel is" over "Gel are" and "Gel + does" over "Gel do." - **Use American English spellings.** Choose "color" over "colour" and "organize" over "organise." - **Use the Oxford comma.** When delineating a series, place a comma between @@ -81,7 +81,7 @@ Documentation style like a computer science textbook. Sometimes that's necessary, but in most cases, it isn't. Prioritize accuracy first and accessibility a close second. - **Be careful using words that have a special meaning in the context of - EdgeDB.** In casual speech or writing, you might talk about a "set" of - something in a generic sense. Using the word this way in EdgeDB documentation - might easily be interpreted as a reference to EdgeDB's `sets `. + Gel.** In casual speech or writing, you might talk about a "set" of + something in a generic sense. Using the word this way in Gel documentation + might easily be interpreted as a reference to Gel's `sets `. Avoid this kind of casual usage of key terms. diff --git a/README.md b/README.md index 4fe98f458b4..3c740cccddb 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@

- - + +

-

EdgeDB

- - Stars +

Gel

+ + Stars - - + + - + license @@ -20,19 +20,19 @@

- Quickstart + Quickstart   •   - Website + Website   •   - Docs + Docs   •   - Playground + Playground   •   - Blog + Blog   •   Discord   •   - Twitter + Twitter
@@ -42,9 +42,9 @@
-

What is EdgeDB?

+

What is Gel?

- EdgeDB is a new kind of database + Gel is a new kind of database
that takes the best parts of
@@ -68,7 +68,7 @@ read, write, and understand. Forget foreign keys; tabular data modeling is a relic of an older age, and it [isn't compatible](https://en.wikipedia.org/wiki/Object%E2%80%93relational_impedance_mismatch) -with modern languages. Instead, EdgeDB thinks about schema the same way you do: +with modern languages. Instead, Gel thinks about schema the same way you do: as **object types** containing **properties** connected by **links**. ```esdl @@ -82,11 +82,11 @@ type Movie { } ``` -This example is intentionally simple, but EdgeDB supports everything you'd +This example is intentionally simple, but Gel supports everything you'd expect from your database: a strict type system, indexes, constraints, computed properties, stored procedures...the list goes on. Plus it gives you some shiny new features too: link properties, schema mixins, and best-in-class JSON -support. Read the [schema docs](https://www.edgedb.com/docs/datamodel/index) +support. Read the [schema docs](https://www.geldata.com/docs/datamodel/index) for details. @@ -97,7 +97,7 @@ for details.


-EdgeDB's super-powered query language EdgeQL is designed as a ground-up +Gel's super-powered query language EdgeQL is designed as a ground-up redesign of SQL. EdgeQL queries produce rich, structured objects, not flat lists of rows. Deeply fetching related objects is painless...bye, bye, JOINs. @@ -131,7 +131,7 @@ insert Movie { There's a lot more to EdgeQL: a comprehensive standard library, computed properties, polymorphic queries, `with` blocks, transactions, and much more. -Read the [EdgeQL docs](https://www.edgedb.com/docs/edgeql/index) for the full +Read the [EdgeQL docs](https://www.geldata.com/docs/edgeql/index) for the full picture.
@@ -140,22 +140,22 @@ picture.
-While EdgeDB solves the same problems as ORM libraries, it's so much more. It's +While Gel solves the same problems as ORM libraries, it's so much more. It's a full-fledged database with a -[powerful and elegant query language](https://www.edgedb.com/docs/edgeql/index), a -[migrations system](https://www.edgedb.com/docs/guides/migrations/index), a -[suite of client libraries](https://www.edgedb.com/docs/clients/index) in +[powerful and elegant query language](https://www.geldata.com/docs/edgeql/index), a +[migrations system](https://www.geldata.com/docs/guides/migrations/index), a +[suite of client libraries](https://www.geldata.com/docs/clients/index) in different languages, a -[command line tool](https://www.edgedb.com/docs/cli/index), and—coming soon—a +[command line tool](https://www.geldata.com/docs/cli/index), and—coming soon—a cloud hosting platform. The goal is to rethink every aspect of how developers model, migrate, manage, and query their database. -Here's a taste-test of EdgeDB's next-level developer experience: you can +Here's a taste-test of Gel's next-level developer experience: you can install our CLI, spin up an instance, and open an interactive EdgeQL shell with just three commands. ``` -$ curl --proto '=https' --tlsv1.2 -sSf https://sh.edgedb.com | sh +$ curl --proto '=https' --tlsv1.2 -sSf https://geldata.com/sh | sh $ edgedb project init $ edgedb edgedb> select "Hello world!" @@ -164,43 +164,46 @@ edgedb> select "Hello world!" Windows users: use this Powershell command to install the CLI. ``` -PS> iwr https://ps1.edgedb.com -useb | iex +PS> iwr https://geldata.com/ps1 -useb | iex ```
## Get started -To start learning about EdgeDB, check out the following resources: +To start learning about Gel, check out the following resources: -- **[The quickstart](https://www.edgedb.com/docs/guides/quickstart)**. If +- **[The quickstart](https://www.geldata.com/docs/guides/quickstart)**. If you're just starting out, the 10-minute quickstart guide is the fastest way to get up and running. -- **[EdgeDB Cloud 🌤️](https://www.edgedb.com/cloud)**. The best - most effortless way to host your EdgeDB database in the cloud. -- **[The interactive tutorial](https://www.edgedb.com/tutorial)**. For a +- **[Gel Cloud 🌤️](https://www.geldata.com/cloud)**. The best + most effortless way to host your Gel database in the cloud. +- **[The interactive tutorial](https://www.geldata.com/tutorial)**. For a structured deep-dive into the EdgeQL query language, try the web-based tutorial— no need to install anything. + - **The docs.** Jump straight into the docs for - [schema modeling](https://www.edgedb.com/docs/datamodel/index) or - [EdgeQL](https://www.edgedb.com/docs/edgeql/index)! + [schema modeling](https://www.geldata.com/docs/datamodel/index) or + [EdgeQL](https://www.geldata.com/docs/edgeql/index)!
## Contributing PRs are always welcome! To get started, follow -[this guide](https://www.edgedb.com/docs/internals/dev) to build EdgeDB from +[this guide](https://www.geldata.com/docs/internals/dev) to build Gel from source on your local machine. -[File an issue 👉](https://github.com/edgedb/edgedb/issues/new/choose) +[File an issue 👉](https://github.com/geldata/gel/issues/new/choose)
-[Start a Discussion 👉](https://github.com/edgedb/edgedb/discussions/new) +[Start a Discussion 👉](https://github.com/geldata/gel/discussions/new)
[Join the discord 👉](https://discord.gg/umUueND6ag)