Skip to content

Commit c0dde70

Browse files
committed
Turn off lint portions of the upgrading guide
We need to specifically reference the old CLI name in the upgrading guide, so turn off the linting rule that disallows referencing it. Also revert major version number bump in the GitHub action.
1 parent 4522b52 commit c0dde70

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

Diff for: docs/resources/upgrading.rst

+12-4
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,22 @@ With the release of Gel v6, we have introduced a number of changes that affect y
99
CLI
1010
===
1111

12-
For a few versions we've been shipping an alias to the ``edgedb`` CLI named ``gel`` as we've been working on the rename. For the most part, you can now just use ``gel`` instead of ``edgedb`` as the CLI name. Make sure you are using the latest version of the CLI by running ``gel cli upgrade``. If you see a note about not being able to upgrade, you can try running ``edgedb cli upgrade`` and then after that ``gel cli upgrade``.
12+
.. lint-off
13+
14+
For a few versions we've been shipping an alias to the ``edgedb`` CLI named ``gel`` as we've been working on the rename. For the most part, you can now just use ``gel`` instead of ``edgedb`` as the CLI name. Make sure you are using the latest version of the CLI by running :gelcmd:`cli upgrade`. If you see a note about not being able to upgrade, you can try running ``edgedb cli upgrade`` and then after that :gelcmd:`cli upgrade`.
1315

1416
Don't forget to update any scripts that use the ``edgedb`` CLI to use ``gel`` instead.
1517

18+
.. lint-on
19+
1620
Project Configuration File
1721
==========================
1822

19-
Gel CLI and client libraries use a configuration file configure various things about your project, such as the location of the schema directory, and the target version of the Gel server. Previously, this file was named ``edgedb.toml``, but it is now named ``gel.toml``.
23+
.. lint-off
24+
25+
Gel CLI and client libraries use a configuration file configure various things about your project, such as the location of the schema directory, and the target version of the Gel server. Previously, this file was named ``edgedb.toml``, but it is now named |gel.toml|.
26+
27+
.. lint-on
2028
2129
In addition to the name change, we have also renamed the TOML table for configuring the server version from ``[edgedb]`` to ``[instance]``.
2230

@@ -101,7 +109,7 @@ If you're using a hosted instance on Gel Cloud, you can upgrade your instance by
101109
Local instances
102110
---------------
103111

104-
If you have local instances that you've intialized with the CLI using ``edgedb project init``, you can upgrade them easily with the CLI.
112+
If you have local instances that you've intialized with the CLI using :gelcmd:`project init`, you can upgrade them easily with the CLI.
105113

106114
.. code-block:: bash
107115
@@ -168,6 +176,6 @@ We publish a GitHub action for accessing a Gel instance in your GitHub Actions w
168176
.. code-block:: yaml-diff
169177
170178
- - uses: edgedb/setup-edgedb@v1
171-
+ - uses: geldata/setup-gel@v2
179+
+ - uses: geldata/setup-gel@v1
172180
- - run: edgedb query 'select sys::get_version_as_str()'
173181
+ - run: gel query 'select sys::get_version_as_str()'

0 commit comments

Comments
 (0)