diff --git a/docs/ai/index.rst b/docs/ai/index.rst index 84a9e5dec15..2e38ad47d8a 100644 --- a/docs/ai/index.rst +++ b/docs/ai/index.rst @@ -22,7 +22,7 @@ AI, Anthropic, and any other provider with a compatible API. Enable extension in your schema =============================== -AI is an |Gel| extension. To enable it, you will need to add the extension +AI is a |Gel| extension. To enable it, you will need to add the extension to your app's schema: .. code-block:: sdl @@ -154,7 +154,7 @@ can define an AI index on an expression: .. note:: When AI indexes aren't working… If you find your queries are not returning the expected results, try - inspecting your instance logs. On an |Gel| Cloud instance, use the "Logs" + inspecting your instance logs. On a |Gel| Cloud instance, use the "Logs" tab in your instance dashboard. On local or :ref:`CLI-linked remote instances `, use :gelcmd:`instance logs -I `. You may find the problem there. diff --git a/docs/ai/javascript.rst b/docs/ai/javascript.rst index 1adbdfe9123..e1822023cef 100644 --- a/docs/ai/javascript.rst +++ b/docs/ai/javascript.rst @@ -28,7 +28,7 @@ Start by importing ``createClient`` from ``gel`` and ``createAI`` from import { createClient } from "gel"; import { createAI } from "@gel/ai"; -Create an |Gel| client. Create an instance of the AI client by passing in the +Create a |Gel| client. Create an instance of the AI client by passing in the Gel client and any options for the AI provider (like the text generation model): diff --git a/docs/ai/reference.rst b/docs/ai/reference.rst index a0a3a930b8f..3ab6e09a8ed 100644 --- a/docs/ai/reference.rst +++ b/docs/ai/reference.rst @@ -184,7 +184,7 @@ When indexes aren't working… ---------------------------- If you find your queries are not returning the expected results, try -inspecting your instance logs. On an |Gel| Cloud instance, use the "Logs" +inspecting your instance logs. On a |Gel| Cloud instance, use the "Logs" tab in your instance dashboard. On local or :ref:`CLI-linked remote instances `, use :gelcmd:`instance logs -I `. You may find the problem there. diff --git a/docs/cli/edgedb_connopts.rst b/docs/cli/edgedb_connopts.rst index 4c83f516486..d97b19c2c43 100644 --- a/docs/cli/edgedb_connopts.rst +++ b/docs/cli/edgedb_connopts.rst @@ -52,7 +52,7 @@ Connection flags if not set, to ``5656``. :cli:synopsis:`--unix-path /path/to/socket` - Specifies a path to a Unix socket for an |Gel| connection. If the path is + Specifies a path to a Unix socket for a |Gel| connection. If the path is a directory, the actual path will be computed using the ``port`` and ``admin`` parameters. diff --git a/docs/cli/edgedb_dump.rst b/docs/cli/edgedb_dump.rst index 98391fdfdb4..17a8d14001a 100644 --- a/docs/cli/edgedb_dump.rst +++ b/docs/cli/edgedb_dump.rst @@ -5,7 +5,7 @@ gel dump ======== -Backup an |Gel| branch (or database pre-v5) to a file. +Backup a |Gel| branch (or database pre-v5) to a file. .. cli:synopsis:: diff --git a/docs/cli/edgedb_instance/edgedb_instance_credentials.rst b/docs/cli/edgedb_instance/edgedb_instance_credentials.rst index 5c20b5ab54f..a69133db0a2 100644 --- a/docs/cli/edgedb_instance/edgedb_instance_credentials.rst +++ b/docs/cli/edgedb_instance/edgedb_instance_credentials.rst @@ -16,7 +16,7 @@ Description =========== :gelcmd:`instance credentials` is a terminal command for displaying the -credentials of an |Gel| instance. +credentials of a |Gel| instance. Options diff --git a/docs/cli/edgedb_instance/edgedb_instance_destroy.rst b/docs/cli/edgedb_instance/edgedb_instance_destroy.rst index cb4ce07df8e..32ad3d16326 100644 --- a/docs/cli/edgedb_instance/edgedb_instance_destroy.rst +++ b/docs/cli/edgedb_instance/edgedb_instance_destroy.rst @@ -5,7 +5,7 @@ gel instance destroy ==================== -Remove an |Gel| instance. +Remove a |Gel| instance. .. cli:synopsis:: diff --git a/docs/cli/edgedb_instance/edgedb_instance_reset_password.rst b/docs/cli/edgedb_instance/edgedb_instance_reset_password.rst index 789217012ce..7efe1ff5827 100644 --- a/docs/cli/edgedb_instance/edgedb_instance_reset_password.rst +++ b/docs/cli/edgedb_instance/edgedb_instance_reset_password.rst @@ -16,7 +16,7 @@ Description =========== :gelcmd:`instance reset-password` is a terminal command for resetting -or updating the password for a user of an |Gel| instance. +or updating the password for a user of a |Gel| instance. .. note:: diff --git a/docs/cli/edgedb_instance/edgedb_instance_restart.rst b/docs/cli/edgedb_instance/edgedb_instance_restart.rst index beb174dbaaf..d9062e72e7c 100644 --- a/docs/cli/edgedb_instance/edgedb_instance_restart.rst +++ b/docs/cli/edgedb_instance/edgedb_instance_restart.rst @@ -5,7 +5,7 @@ gel instance restart ==================== -Restart an |Gel| instance. +Restart a |Gel| instance. .. cli:synopsis:: diff --git a/docs/cli/edgedb_instance/edgedb_instance_start.rst b/docs/cli/edgedb_instance/edgedb_instance_start.rst index 593cebbf94a..c0420474bb3 100644 --- a/docs/cli/edgedb_instance/edgedb_instance_start.rst +++ b/docs/cli/edgedb_instance/edgedb_instance_start.rst @@ -5,7 +5,7 @@ gel instance start ================== -Start an |Gel| instance. +Start a |Gel| instance. .. cli:synopsis:: diff --git a/docs/cli/edgedb_instance/edgedb_instance_stop.rst b/docs/cli/edgedb_instance/edgedb_instance_stop.rst index 8404c07ec9c..c93f0ec0884 100644 --- a/docs/cli/edgedb_instance/edgedb_instance_stop.rst +++ b/docs/cli/edgedb_instance/edgedb_instance_stop.rst @@ -5,7 +5,7 @@ gel instance stop ================= -Stop an |Gel| instance. +Stop a |Gel| instance. .. cli:synopsis:: diff --git a/docs/cli/edgedb_migrate.rst b/docs/cli/edgedb_migrate.rst index 6db0afd2462..f2bc6bc436b 100644 --- a/docs/cli/edgedb_migrate.rst +++ b/docs/cli/edgedb_migrate.rst @@ -10,7 +10,7 @@ database using this command. .. warning:: Gel Cloud CI users and scripters - When scripting a ``migrate``/``migration apply`` for an |Gel| Cloud + When scripting a ``migrate``/``migration apply`` for a |Gel| Cloud instance, do not use :gelcmd:`login` to authenticate. Instead, you should generate a secret key in the Gel Cloud UI or by running :ref:`ref_cli_gel_cloud_secretkey_create` and set the diff --git a/docs/cli/edgedb_migration/edgedb_migration_apply.rst b/docs/cli/edgedb_migration/edgedb_migration_apply.rst index 9a78d3f9a7c..ed6051829b6 100644 --- a/docs/cli/edgedb_migration/edgedb_migration_apply.rst +++ b/docs/cli/edgedb_migration/edgedb_migration_apply.rst @@ -18,7 +18,7 @@ target instance. .. warning:: Gel Cloud CI users and scripters - When scripting a ``migrate``/``migration apply`` for an |Gel| Cloud + When scripting a ``migrate``/``migration apply`` for a |Gel| Cloud instance, do not use :gelcmd:`login` to authenticate. Instead, you should generate a secret key in the Gel Cloud UI or by running :ref:`ref_cli_gel_cloud_secretkey_create` and set the diff --git a/docs/clients/connection.rst b/docs/clients/connection.rst index d8cd8d0f117..1afb08edd43 100644 --- a/docs/clients/connection.rst +++ b/docs/clients/connection.rst @@ -21,7 +21,7 @@ library. - Set the ``EDGEDB_INSTANCE`` environment variable to a :ref:`name ` of a local instance, remote linked - instance, or an |Gel| Cloud instance. (:ref:`More info on |Gel| Cloud + instance, or a |Gel| Cloud instance. (:ref:`More info on |Gel| Cloud connection details below. `) You can create new instances manually with the :ref:`gel instance create ` command. @@ -54,7 +54,7 @@ on connection configuration, see :ref:`Reference > Connection Parameters Gel Cloud ========= -To provide client connection information for an |Gel| Cloud instance, set the +To provide client connection information for a |Gel| Cloud instance, set the ``EDGEDB_INSTANCE`` variable to the instance name (``/`` where ```` is the name you set when you created the Gel Cloud instance) and the ``EDGEDB_SECRET_KEY`` diff --git a/docs/clients/go/api.rst b/docs/clients/go/api.rst index 2b12242d249..dc7c46b6d2b 100644 --- a/docs/clients/go/api.rst +++ b/docs/clients/go/api.rst @@ -85,7 +85,7 @@ ModuleAlias is an alias name and module name pair. *type* Options -------------- -Options for connecting to an |Gel| server +Options for connecting to a |Gel| server .. code-block:: go diff --git a/docs/clients/go/codegen.rst b/docs/clients/go/codegen.rst index e451de48f2a..23b693f4d1d 100644 --- a/docs/clients/go/codegen.rst +++ b/docs/clients/go/codegen.rst @@ -2,7 +2,7 @@ Codegen ======= edgeql-go is a tool to generate go functions from edgeql queries. When run -in an |Gel| project directory (or subdirectory) a \*_edgeql.go source file +in a |Gel| project directory (or subdirectory) a \*_edgeql.go source file will be generated for each \*.edgeql file. The generated go will have an edgeqlFileName and edgeqlFileNameJSON function with typed arguments and return value matching the query's arguments and result shape. diff --git a/docs/clients/go/types.rst b/docs/clients/go/types.rst index 14a60074e12..9b9281defc2 100644 --- a/docs/clients/go/types.rst +++ b/docs/clients/go/types.rst @@ -94,7 +94,7 @@ from a `time.Duration `_ represented as nanoseconds. func ParseDuration(s string) (Duration, error) -ParseDuration parses an |Gel| duration string. +ParseDuration parses a |Gel| duration string. diff --git a/docs/clients/graphql/index.rst b/docs/clients/graphql/index.rst index 43ac4567762..0297f4c89b3 100644 --- a/docs/clients/graphql/index.rst +++ b/docs/clients/graphql/index.rst @@ -72,7 +72,7 @@ To execute a GraphQL query against the |main| branch on the instance named ``inst2``, we would send an HTTP request to ``http://localhost:10702/branch/gel/main``. -To determine the URL of an |Gel| Cloud instance, find the host by running +To determine the URL of a |Gel| Cloud instance, find the host by running :gelcmd:`instance credentials -I /`. Use the ``host`` and ``port`` from that table in the URL format at the top of this section. Change the protocol to ``https`` since Gel Cloud instances are diff --git a/docs/clients/http/index.rst b/docs/clients/http/index.rst index 95fb5e094ac..701f32a146b 100644 --- a/docs/clients/http/index.rst +++ b/docs/clients/http/index.rst @@ -44,7 +44,7 @@ Your instance can now receive EdgeQL queries over HTTP at want to query another branch instead, simply use that branch name in the URL. - To determine the URL of an |Gel| Cloud instance, find the host by running + To determine the URL of a |Gel| Cloud instance, find the host by running :gelcmd:`instance credentials -I /`. Use the ``host`` and ``port`` from that table in the URL format above this note. Change the protocol to ``https`` since Gel Cloud instances are secured @@ -70,7 +70,7 @@ By default, the HTTP endpoint uses :eql:type:`cfg::Password` based authentication, in which `HTTP Basic Authentication `_ -is used to provide an |Gel| username and password. +is used to provide a |Gel| username and password. .. lint-on diff --git a/docs/clients/js/reference.rst b/docs/clients/js/reference.rst index 05485b54abf..cf0e1b228fb 100644 --- a/docs/clients/js/reference.rst +++ b/docs/clients/js/reference.rst @@ -763,7 +763,7 @@ Local Date month: number, \ day: number) - A JavaScript representation of an |Gel| ``local_date`` value. Implements + A JavaScript representation of a |Gel| ``local_date`` value. Implements a subset of the `TC39 Temporal Proposal`_ ``PlainDate`` type. Assumes the calendar is always `ISO 8601`_. @@ -909,7 +909,7 @@ Local Date and Time microsecond: number = 0, \ nanosecond: number = 0) extends LocalDate, LocalTime - A JavaScript representation of an |Gel| ``local_datetime`` value. + A JavaScript representation of a |Gel| ``local_datetime`` value. Implements a subset of the `TC39 Temporal Proposal`_ ``PlainDateTime`` type. diff --git a/docs/cloud/http_gql.rst b/docs/cloud/http_gql.rst index 88a6f90e64f..48b3b5a07e3 100644 --- a/docs/cloud/http_gql.rst +++ b/docs/cloud/http_gql.rst @@ -37,7 +37,7 @@ Your instance can now receive EdgeQL queries over HTTP at Instance URL ============ -To determine the URL of an |Gel| Cloud instance, find the host by running +To determine the URL of a |Gel| Cloud instance, find the host by running :gelcmd:`instance credentials -I /`. Use the ``host`` and ``port`` from that table in the URL format above this note. Change the protocol to ``https`` since Gel Cloud instances are secured @@ -70,7 +70,7 @@ example showing how you might send the query ``select Person {*};`` using cURL: Usage ===== -Usage of the HTTP and GraphQL APIs is identical on an |Gel| Cloud instance. +Usage of the HTTP and GraphQL APIs is identical on a |Gel| Cloud instance. Reference the HTTP and GraphQL documentation for more information. diff --git a/docs/datamodel/index.rst b/docs/datamodel/index.rst index 70db6823e63..4f844fed886 100644 --- a/docs/datamodel/index.rst +++ b/docs/datamodel/index.rst @@ -102,7 +102,7 @@ Terminology Instance ^^^^^^^^ -An |Gel| **instance** is a running Gel process. Instances can be created, +A |Gel| **instance** is a running Gel process. Instances can be created, started, stopped, and destroyed locally with the :ref:`Gel CLI `.