Skip to content

Commit

Permalink
Docs links updates (#6993)
Browse files Browse the repository at this point in the history
* Update some docs links to use refs + add/remove host for some links to work with new docs site

* Fix CI

* Convert more client lib links to refs

* Add query parameter types heading ref

* Ignore missing ref errors for client docs
  • Loading branch information
jaclarke authored and raddevon committed Mar 6, 2024
1 parent 064e4b4 commit 210a1ef
Show file tree
Hide file tree
Showing 31 changed files with 100 additions and 92 deletions.
4 changes: 2 additions & 2 deletions docs/changelog/1_0_a2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
===========

This changelog summarizes new features and breaking changes in
`EdgeDB 1.0 alpha 2 </blog/edgedb-1-0-alpha-2>`_.
`EdgeDB 1.0 alpha 2 <https://www.edgedb.com/blog/edgedb-1-0-alpha-2>`_.


New JavaScript Driver
Expand Down Expand Up @@ -47,7 +47,7 @@ and it is ready for use:
main();
The documentation can be found `here </docs/clients/01_js/index>`_.
The documentation can be found :ref:`here <edgedb-js-intro>`.


Standard Library
Expand Down
2 changes: 1 addition & 1 deletion docs/changelog/1_0_a3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

This changelog summarizes new features and breaking changes in
`EdgeDB 1.0 alpha 3 "Proxima Centauri"
</blog/edgedb-1-0-alpha-3-proxima-centauri>`_.
<https://www.edgedb.com/blog/edgedb-1-0-alpha-3-proxima-centauri>`_.


CLI
Expand Down
2 changes: 1 addition & 1 deletion docs/changelog/1_0_a4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

This changelog summarizes new features and breaking changes in
`EdgeDB 1.0 alpha 4 "Barnard's Star"
</blog/edgedb-1-0-alpha-4-barnard-s-star>`_.
<https://www.edgedb.com/blog/edgedb-1-0-alpha-4-barnard-s-star>`_.


EdgeQL
Expand Down
5 changes: 2 additions & 3 deletions docs/changelog/1_0_a5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
===========

This changelog summarizes new features and breaking changes in
`EdgeDB 1.0 alpha 5 "Luhman" </blog/edgedb-1-0-alpha-5-luhman>`_.
`EdgeDB 1.0 alpha 5 "Luhman" <https://www.edgedb.com/blog/edgedb-1-0-alpha-5-luhman>`_.


EdgeQL
Expand Down Expand Up @@ -108,8 +108,7 @@ CLI
Bindings
========

* Add transaction `API
</docs/clients/01_js/api/connection#connection>`_ to JS binding
* Add transaction :ref:`API <edgedb-js-api-transaction>` to JS binding
(`#61 <https://github.com/edgedb/edgedb-js/pull/61>`_). Here's an
example of using transactions:

Expand Down
2 changes: 1 addition & 1 deletion docs/changelog/2_x.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ upgrade.
- ``[email protected]``
* - :ref:`Python <edgedb-python-intro>`
- ``[email protected]``
* - `Golang <https://www.edgedb.com/docs/clients/go/index>`_
* - :ref:`Golang <edgedb-go-intro>`
- ``[email protected]``
* - `Rust <https://github.com/edgedb/edgedb-rust>`_
- ``[email protected]``
Expand Down
2 changes: 2 additions & 0 deletions docs/clients/dart/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _edgedb-dart-intro:

====
Dart
====
Expand Down
2 changes: 2 additions & 0 deletions docs/clients/dotnet/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _edgedb-dotnet-intro:

====
.NET
====
Expand Down
2 changes: 2 additions & 0 deletions docs/clients/go/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _edgedb-go-intro:

==
Go
==
Expand Down
14 changes: 6 additions & 8 deletions docs/clients/rust/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,24 +120,22 @@ the `blog post introducing the EdgeDB projects CLI`_.
and ``edgedb migrate``.

- a ``/migrations`` folder with ``.edgeql`` files named starting at
``00001``. These hold the `ddl`_ commands that were used to migrate your
schema. A new file shows up in this directory every time your schema
is migrated.
``00001``. These hold the :ref:`ddl <ref_eql_ddl>` commands that were used
to migrate your schema. A new file shows up in this directory every time
your schema is migrated.

If you are running EdgeDB 3.0 and above, you also have the option of using
the `edgedb watch`_ command. Doing so starts a long-running process that
keeps an eye on changes in ``/dbschema``, automatically applying these
changes in real time.
the :ref:`edgedb watch <ref_cli_edgedb_watch>` command. Doing so starts a
long-running process that keeps an eye on changes in ``/dbschema``,
automatically applying these changes in real time.

Now that you have the right dependencies and an EdgeDB instance,
you can create a client.

.. _`blog post introducing the EdgeDB projects CLI`:
https://www.edgedb.com/blog/introducing-edgedb-projects
.. _`bridging methods`: https://tokio.rs/tokio/topics/bridging
.. _`ddl`: https://www.edgedb.com/docs/reference/ddl/index
.. _`edgedb-derive`: https://docs.rs/edgedb-derive/latest/edgedb_derive/
.. _`edgedb-protocol`: https://docs.rs/edgedb-protocol/latest/edgedb_protocol
.. _`edgedb-tokio`: https://docs.rs/edgedb-tokio/latest/edgedb_tokio
.. _`edgedb watch`: https://www.edgedb.com/docs/cli/edgedb_watch
.. _`examples repo`: https://github.com/Dhghomon/edgedb_rust_client_examples
10 changes: 4 additions & 6 deletions docs/clients/rust/transactions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Transactions
------------

The client also has a ``.transaction()`` method that
allows for atomic `transactions`_.
allows for atomic :ref:`transactions <ref_eql_transactions>`.

Wikipedia has a good example of a scenario requiring a transaction which we
can then implement:
Expand Down Expand Up @@ -63,11 +63,9 @@ another's would look like this:
.. note::

What often may seem to require an atomic transaction can instead be
achieved with links and `backlinks`_ which are both idiomatic and easy to
use in EdgeDB. For example, if one object holds a ``required link`` to two
achieved with links and :ref:`backlinks <ref_eql_paths_backlinks>` which
are both idiomatic and easy to use in EdgeDB.
For example, if one object holds a ``required link`` to two
other objects and each of these two objects has a single backlink to the
first one, simply updating the first object will effectively change the
state of the other two instantaneously.

.. _`backlinks`: https://www.edgedb.com/docs/edgeql/paths#backlinks
.. _`transactions`: https://www.edgedb.com/docs/edgeql/transactions
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False

suppress_warnings = ['image.not_readable']

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False

Expand Down
10 changes: 5 additions & 5 deletions docs/edgeql/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,15 @@ like code and less like word soup.
to write deep, performant queries that traverse links, no ``JOINs`` required.

**Composable**. `Unlike SQL
</blog/we-can-do-better-than-sql#lack-of-orthogonality>`_, EdgeQL's syntax is
readily composable; queries can be cleanly nested without worrying about
Cartesian explosion.
<https://www.edgedb.com/blog/we-can-do-better-than-sql#lack-of-orthogonality>`_,
EdgeQL's syntax is readily composable; queries can be cleanly nested without
worrying about Cartesian explosion.

.. note::

For a detailed writeup on the design of SQL, see `We Can Do Better Than SQL
</blog/we-can-do-better-than-sql#lack-of-orthogonality>`_ on the EdgeDB
blog.
<https://www.edgedb.com/blog/we-can-do-better-than-sql#lack-of-orthogonality>`_
on the EdgeDB blog.

Follow along
------------
Expand Down
2 changes: 2 additions & 0 deletions docs/edgeql/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ Refer to the Datatypes page of your preferred :ref:`client library
language-native types.


.. _ref_eql_params_types:

Parameter types and JSON
------------------------

Expand Down
4 changes: 2 additions & 2 deletions docs/edgeql/sets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,8 @@ of data; in EdgeDB the absence of data is just an empty set.
permeates all of SQL and is often handled inconsistently in different
circumstances. A number of specific inconsistencies are documented in detail
in the `We Can Do Better Than SQL
</blog/we-can-do-better-than-sql#null-a-bag-of-surprises>`_ post on the
EdgeDB blog. For broader context, see Tony Hoare's talk
<https://www.edgedb.com/blog/we-can-do-better-than-sql#null-a-bag-of-surprises>`_
post on the EdgeDB blog. For broader context, see Tony Hoare's talk
`"The Billion Dollar Mistake" <https://bit.ly/3H238oG>`_.


Expand Down
10 changes: 4 additions & 6 deletions docs/edgeql/transactions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,7 @@ Using the querybuilder:
await query2.run(tx);
});
Full documentation at `Client Libraries > TypeScript/JS
</docs/clients/01_js/index>`_;
Full documentation at :ref:`Client Libraries > TypeScript/JS <edgedb-js-intro>`;

Python
^^^^^^
Expand All @@ -113,8 +112,7 @@ Python
filter .name = 'Customer2'
set { bank_balance := .bank_balance +10 };""")
Full documentation at `Client Libraries > Python
</docs/clients/00_python/index>`_;
Full documentation at :ref:`Client Libraries > Python <edgedb-python-intro>`;

Golang
^^^^^^
Expand All @@ -140,7 +138,7 @@ Golang
log.Fatal(err)
}
Full documentation at `Client Libraries > Go </docs/clients/02_go/index>`_.
Full documentation at :ref:`Client Libraries > Go <edgedb-go-intro>`.

Rust
^^^^
Expand All @@ -164,4 +162,4 @@ Rust
.await
.expect("Transaction should have worked");
Full documentation at `Client Libraries > Rust </docs/clients/rust/index>`_.
Full documentation at :ref:`Client Libraries > Rust <ref_rust_index>`.
2 changes: 1 addition & 1 deletion docs/guides/cloud/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ better!
<https://www.edgedbstatus.com/>`_ for information on what may be
causing it.
* Report any bugs you find by `submitting a support ticket
<https://edgedb.com/p/cloud-support>`_. Note: when using EdgeDB Cloud
<https://www.edgedb.com/p/cloud-support>`_. Note: when using EdgeDB Cloud
through the CLI, setting the ``RUST_LOG`` environment variable to ``info``,
``debug``, or ``trace`` may provide additional debugging information
which will be useful to include with your ticket.
7 changes: 3 additions & 4 deletions docs/guides/contributing/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,12 @@ find it alongside the client itself. These clients will also have documentation
stubs inside the edgedb repository directing you to the documentation's
location.

The `EdgeDB tutorial <https://www.edgedb.com/tutorial>`_ is part of `our web
The `EdgeDB tutorial </tutorial>`_ is part of `our web
site repository <https://github.com/edgedb/website>`_. You'll find it in `the
tutorial directory <https://github.com/edgedb/website/tree/main/tutorial>`_.

Finally, our book for beginners titled `Easy EdgeDB
<https://www.edgedb.com/easy-edgedb>`_ lives in `its own repo
<https://github.com/edgedb/easy-edgedb>`_.
Finally, our book for beginners titled `Easy EdgeDB </easy-edgedb>`_ lives in
`its own repo <https://github.com/edgedb/easy-edgedb>`_.


How to Build It
Expand Down
4 changes: 1 addition & 3 deletions docs/guides/deployment/heroku.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,12 @@ First copy the code, initialize a new git repo, and create a new heroku app.
$ heroku apps:create --buildpack heroku/nodejs
$ edgedb project init --non-interactive
If you are using the `JS query builder for EdgeDB <js-query-builder_>`_ then
If you are using the :ref:`JS query builder for EdgeDB <edgedb-js-qb>` then
you will need to check the ``dbschema/edgeql-js`` directory in to your git
repo after running ``yarn edgeql-js``. The ``edgeql-js`` command cannot be
run during the build step on Heroku because it needs access to a running
EdgeDB instance which is not available at build time on Heroku.

.. _js-query-builder: https://www.edgedb.com/docs/clients/js/index

.. code-block:: bash
$ yarn install && npx @edgedb/generate edgeql-js
Expand Down
12 changes: 3 additions & 9 deletions docs/guides/migrations/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -612,7 +612,7 @@ require appending ``--allow-empty`` to the command. Just do the following:
schema file manually, copy the suggested name into the migration hash
and type ``edgedb migrate`` again.

The `EdgeDB tutorial <tutorial_>`_ is a good example of a database
The `EdgeDB tutorial </tutorial>`_ is a good example of a database
set up with both a schema migration and a data migration. Setting
up a database with `schema changes in one file and default data in
a second file <tutorial_files_>`_ is a nice way to separate the two operations
Expand Down Expand Up @@ -1204,7 +1204,7 @@ want to accept all of the suggestions provided by the server. This
process is in fact still used to migrate even today; the CLI just
facilitates it by making it easy to respond to the generated suggestions.
`Early EdgeDB migrations took place inside a transaction <transaction_>`_
:ref:`Early EdgeDB migrations took place inside a transaction <ref_eql_ddl_migrations>`
handled by the user that essentially went like this:
.. code-block::
Expand Down Expand Up @@ -1353,11 +1353,5 @@ migration and give it a proper ``.edgeql`` file in the same way we
did above in the "So you really wanted to use DDL but now regret it?"
section.
.. lint-off
.. _rfc: https://github.com/edgedb/rfcs/blob/master/text/1000-migrations.rst
.. _transaction: https://www.edgedb.com/docs/reference/ddl/migrations
.. _tutorial: https://www.edgedb.com/tutorial
.. _tutorial_files: https://github.com/edgedb/website/tree/main/content/tutorial/dbschema/migrations
.. lint-on
.. _tutorial_files: https://github.com/edgedb/website/tree/main/content/tutorial/dbschema/migrations
8 changes: 4 additions & 4 deletions docs/guides/tutorials/chatgpt_bot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -457,8 +457,8 @@ database because of the ``pgvector`` extension. In order to use it in our
schema, we have to activate the ``ext::pgvector`` module with ``using extension
pgvector`` at the beginning of the schema file. This module gives us access to
the ``ext::pgvector::vector`` data type as well as few similarity functions and
indexes we can use later to retrieve embeddings. Read our `pgvector
documentation <https://www.edgedb.com/docs/stdlib/pgvector>`_ for more details
indexes we can use later to retrieve embeddings. Read our :ref:`pgvector
documentation <ref_ext_pgvector>` for more details
on the extension.
Just below that, we can start building our module by creating a new scalar
Expand Down Expand Up @@ -603,8 +603,8 @@ libraries that will help us.
The ``@edgedb/generate`` package provides a set of code generation tools that
are useful when developing an EdgeDB-backed applications with
TypeScript/JavaScript. We're going to write queries using our `query builder
<https://www.edgedb.com/docs/clients/js/querybuilder>`_, but before we can, we
TypeScript/JavaScript. We're going to write queries using our
:ref:`query builder <edgedb-js-qb>`, but before we can, we
need to run the query builder generator.
.. code-block:: bash
Expand Down
3 changes: 1 addition & 2 deletions docs/guides/tutorials/cloudflare_workers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,10 @@ Prerequisites
Ensure you have the following installed:

- `Node.js`_
- `EdgeDB CLI`_
- :ref:`EdgeDB CLI <ref_intro_cli>`

.. _Sign up for a Cloudflare account: https://dash.cloudflare.com/sign-up
.. _Node.js: https://nodejs.org/en/
.. _EdgeDB CLI: https://www.edgedb.com/docs/intro/cli

Setup and configuration
-----------------------
Expand Down
Loading

0 comments on commit 210a1ef

Please sign in to comment.