Skip to content

Commit

Permalink
+ alt text
Browse files Browse the repository at this point in the history
  • Loading branch information
Dhghomon committed Jan 12, 2024
1 parent 405fac2 commit 227d7d5
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/guides/migrations/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ To see what a schema migration file looks like, type ``edgedb migration
create`` and then hit ``y`` to say yes to the question you see below:


.. code-block:: console
.. code-block::
db> did you create object type 'default::User'? [y,n,l,c,b,s,q,?]
> y
Expand Down
4 changes: 3 additions & 1 deletion docs/ui/client_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ Client settings
===============

.. image:: images/client_settings.png
:alt: Todo
:alt: The EdgeDB client settings dropdown bar showing two sample settings
that can be set: apply access policies, and implicit limit. Apply
access policies is set to false, and implicit limit is set to 100.
:width: 100%

The UI exposes a number of :ref:`configuration parameters <ref_std_cfg>`
Expand Down
5 changes: 4 additions & 1 deletion docs/ui/data_explorer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ Data Explorer
=============

.. image:: images/data_explorer.png
:alt: Todo
:alt: The Data Explorer page in the EdgeDB UI. The icon is three bars
stacked on top of each other: blue, purple, and orange. A sample
query via the Data Explorer shows information about a user-defined
object type called a Booking.
:width: 100%

The data explorer is similar to the UI editor in facilitating queries on
Expand Down
7 changes: 6 additions & 1 deletion docs/ui/database_dashboard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ Dashboard
=========

.. image:: images/database_dashboard.png
:alt: Todo
:alt: The Database Dashboard page in the EdgeDB UI. Large green buttons
give access to other pages such as the REPL, Editor, and
Schema Viewer. The total number of objects and object types in
the database are displayed below, along with links to parts of the
EdgeDB website such as the Quickstart, Tutorial, and Easy EdgeDB
book.
:width: 100%

The dashboard for each database displays the number of object types and
Expand Down
7 changes: 6 additions & 1 deletion docs/ui/editor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ Editor
======

.. image:: images/editor.png
:alt: Todo
:alt: The Editor page in the EdgeDB UI, inside which the Query Builder
is shown as the user puts together a query to see the name property
for a user-defined type called Book. A filter on the object's id
and a limit to the number of object types returned are being set.
The Editor icon is a blue square resembling a pad, with an orange
line resembling a pencil on top.
:width: 100%

Query Editor
Expand Down
6 changes: 5 additions & 1 deletion docs/ui/schema_viewer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ Schema Viewer
=============

.. image:: images/schema_viewer.png
:alt: Todo
:alt: The Schema Viewer page in the EdgeDB UI. The icon is two small
squares of blue and orange, connected by a purple line. A small
user-defined sample schema is shown with two concrete types
called Book and Library, along with an abstract type called
HasAddress that is extended by the Library type.
:width: 100%

The UI schema viewer allows you to see your schema either as text, graph,
Expand Down
6 changes: 5 additions & 1 deletion docs/ui/ui_home.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ UI Home
=======

.. image:: images/ui_home.png
:alt: Todo
:alt: The instance homepage in the EdgeDB UI. The instance name, called
myinstance, is shown on the top. One button gives access to a
database known as edgedb, another button to create an example
database, and a third button allows for the creation of a
new database.
:width: 100%

The UI homepage displays one button per database inside the instance.
Expand Down
5 changes: 4 additions & 1 deletion docs/ui/ui_repl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ REPL
====

.. image:: images/ui_repl.png
:alt: Todo
:alt: The REPL page in the EdgeDB UI. The icon is a blue right-facing
angle bracket followed by an orange underscore, representing a
cursor awaiting user input. The output for a query on a
user-defined type called a Booking Log Entry is displayed.
:width: 100%

The REPL used in the EdgeDB UI is largely the same as the CLI REPL,
Expand Down

0 comments on commit 227d7d5

Please sign in to comment.