Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation for UI #6722

Open
wants to merge 87 commits into
base: master
Choose a base branch
from
Open

Documentation for UI #6722

wants to merge 87 commits into from
+485 −1

Commits on Jan 3, 2024

  1. Add schema migration guide, reorder and rename in places

    @Dhghomon
    Dhghomon committed Jan 3, 2024
    Configuration menu
    Copy the full SHA
    6212d44 View commit details
    Browse the repository at this point in the history

Commits on Jan 4, 2024

  1. rv backlink.rst

    @Dhghomon
    Dhghomon committed Jan 4, 2024
    Configuration menu
    Copy the full SHA
    56816d9 View commit details
    Browse the repository at this point in the history

Commits on Jan 8, 2024

  1. Squish tips into single file

    @Dhghomon
    Dhghomon committed Jan 8, 2024
    Configuration menu
    Copy the full SHA
    3b56556 View commit details
    Browse the repository at this point in the history

Commits on Jan 9, 2024

  1. Add UI docs

    @Dhghomon
    Dhghomon committed Jan 9, 2024
    Configuration menu
    Copy the full SHA
    0872b1f View commit details
    Browse the repository at this point in the history

  2. Add UI to index

    @Dhghomon
    Dhghomon committed Jan 9, 2024
    Configuration menu
    Copy the full SHA
    5c8a323 View commit details
    Browse the repository at this point in the history

Commits on Jan 11, 2024

  1. +images

    @Dhghomon
    Dhghomon committed Jan 11, 2024
    Configuration menu
    Copy the full SHA
    48b75d3 View commit details
    Browse the repository at this point in the history

  2. redo schema viewer

    @Dhghomon
    Dhghomon committed Jan 11, 2024
    Configuration menu
    Copy the full SHA
    af6bc28 View commit details
    Browse the repository at this point in the history

  3. line length

    @Dhghomon
    Dhghomon committed Jan 11, 2024
    Configuration menu
    Copy the full SHA
    6830970 View commit details
    Browse the repository at this point in the history

  4. More line length

    @Dhghomon
    Dhghomon committed Jan 11, 2024
    Configuration menu
    Copy the full SHA
    f21195d View commit details
    Browse the repository at this point in the history

  5. wax on, wax off

    @Dhghomon
    Dhghomon committed Jan 11, 2024
    Configuration menu
    Copy the full SHA
    8b95dad View commit details
    Browse the repository at this point in the history

  6. Change code block

    @Dhghomon
    Dhghomon committed Jan 11, 2024
    Configuration menu
    Copy the full SHA
    00d0f58 View commit details
    Browse the repository at this point in the history

  7. .

    @Dhghomon
    Dhghomon committed Jan 11, 2024
    Configuration menu
    Copy the full SHA
    6bba059 View commit details
    Browse the repository at this point in the history

  8. Rephrase

    @Dhghomon
    Dhghomon committed Jan 11, 2024
    Configuration menu
    Copy the full SHA
    125c3c7 View commit details
    Browse the repository at this point in the history

Commits on Jan 12, 2024

  1. rv edgeql-repl in places

    @Dhghomon
    Dhghomon committed Jan 12, 2024
    Configuration menu
    Copy the full SHA
    405fac2 View commit details
    Browse the repository at this point in the history

  2. + alt text

    @Dhghomon
    Dhghomon committed Jan 12, 2024
    Configuration menu
    Copy the full SHA
    227d7d5 View commit details
    Browse the repository at this point in the history

  3. Move migration tip to other page

    @Dhghomon
    Dhghomon committed Jan 12, 2024
    Configuration menu
    Copy the full SHA
    ba655f4 View commit details
    Browse the repository at this point in the history

  4. Links, wording

    @Dhghomon
    Dhghomon committed Jan 12, 2024
    Configuration menu
    Copy the full SHA
    89abdc6 View commit details
    Browse the repository at this point in the history

  5. +tips on relative difficulty

    @Dhghomon
    Dhghomon committed Jan 12, 2024
    Configuration menu
    Copy the full SHA
    dc5e578 View commit details
    Browse the repository at this point in the history

  6. +query editor image

    @Dhghomon
    Dhghomon committed Jan 12, 2024
    Configuration menu
    Copy the full SHA
    26909ce View commit details
    Browse the repository at this point in the history

  7. fix dots

    @Dhghomon
    Dhghomon committed Jan 12, 2024
    Configuration menu
    Copy the full SHA
    f0e4a52 View commit details
    Browse the repository at this point in the history

Commits on Jan 17, 2024

  1. Rv UI docs (now in other branch)

    @Dhghomon
    Dhghomon committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    00c6d66 View commit details
    Browse the repository at this point in the history

  2. Fix query

    @Dhghomon
    Dhghomon committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    6f8aff1 View commit details
    Browse the repository at this point in the history

  3. Change block (not meant to be parsed)

    @Dhghomon
    Dhghomon committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    cba3f81 View commit details
    Browse the repository at this point in the history

Commits on Jan 18, 2024

  1. Change to REPL

    @Dhghomon
    Dhghomon committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    950e200 View commit details
    Browse the repository at this point in the history

  2. ui docs

    @Dhghomon
    Dhghomon committed Jan 18, 2024
    Configuration menu
    Copy the full SHA
    71c65c6 View commit details
    Browse the repository at this point in the history

Commits on Jan 19, 2024

  1. First migration: explain why questions now asked

    @Dhghomon
    Dhghomon committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    c1abca9 View commit details
    Browse the repository at this point in the history

  2. Move above "The DDL..." sentence

    @Dhghomon
    Dhghomon committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    7986268 View commit details
    Browse the repository at this point in the history

  3. Rephase why backslash commands are faster

    @Dhghomon
    Dhghomon committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    b5fd29c View commit details
    Browse the repository at this point in the history

  4. Move output up

    @Dhghomon
    Dhghomon committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    9d4a076 View commit details
    Browse the repository at this point in the history

  5. Fix type name

    @Dhghomon
    Dhghomon committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    b973f9a View commit details
    Browse the repository at this point in the history

  6. Line length

    @Dhghomon
    Dhghomon committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    aa87adc View commit details
    Browse the repository at this point in the history

Commits on Jan 22, 2024

  1. First 20 suggestions from code review 

    Co-authored-by: Devon Campbell <devon@edgedb.com>
    @Dhghomon @raddevon
    Dhghomon and raddevon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    6d62ff1 View commit details
    Browse the repository at this point in the history

  2. Next 20 suggestions from code review 

    Co-authored-by: Devon Campbell <devon@edgedb.com>
    @Dhghomon @raddevon
    Dhghomon and raddevon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    b091116 View commit details
    Browse the repository at this point in the history

  3. Next 20 suggestions from code review 

    Co-authored-by: Devon Campbell <devon@edgedb.com>
    @Dhghomon @raddevon
    Dhghomon and raddevon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    8bbaae2 View commit details
    Browse the repository at this point in the history

  4. Next 20 suggestions from code review 

    Co-authored-by: Devon Campbell <devon@edgedb.com>
    @Dhghomon @raddevon
    Dhghomon and raddevon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    f9009ae View commit details
    Browse the repository at this point in the history

  5. Apply suggestions from code review 

    Co-authored-by: Devon Campbell <devon@edgedb.com>
    @Dhghomon @raddevon
    Dhghomon and raddevon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    2b92bd6 View commit details
    Browse the repository at this point in the history

  6. Hint that difference is very small

    @Dhghomon
    Dhghomon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    0b2663e View commit details
    Browse the repository at this point in the history

  7. Add section ref

    @Dhghomon
    Dhghomon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    57817ef View commit details
    Browse the repository at this point in the history

  8. Fix ref, blank space

    @Dhghomon
    Dhghomon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    4a423c7 View commit details
    Browse the repository at this point in the history

  9. Add migration edit

    @Dhghomon
    Dhghomon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    e7ff59d View commit details
    Browse the repository at this point in the history

  10. Note on when DDL is disabled

    @Dhghomon
    Dhghomon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    f16ce48 View commit details
    Browse the repository at this point in the history

  11. typo

    @Dhghomon
    Dhghomon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    eb59c8e View commit details
    Browse the repository at this point in the history

  12. Apply suggestions from code review 

    Co-authored-by: Devon Campbell <devon@edgedb.com>
    @Dhghomon @raddevon
    Dhghomon and raddevon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    d151ee1 View commit details
    Browse the repository at this point in the history

  13. Explain the grouping query

    @Dhghomon
    Dhghomon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    7c4494f View commit details
    Browse the repository at this point in the history

  14. Apply suggestion from code review 

    Co-authored-by: Devon Campbell <devon@edgedb.com>
    @Dhghomon @raddevon
    Dhghomon and raddevon committed Jan 22, 2024
    Configuration menu
    Copy the full SHA
    242906d View commit details
    Browse the repository at this point in the history

Commits on Jan 23, 2024

  1. Small hint about commenting out

    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    59c9dd8 View commit details
    Browse the repository at this point in the history

  2. Inline edgedb watch, rephrase here and there

    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    b502329 View commit details
    Browse the repository at this point in the history

  3. Multiple migrations: clarify invite to follow along

    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    f4cea98 View commit details
    Browse the repository at this point in the history

  4. Add tip on destroying instances

    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    986d069 View commit details
    Browse the repository at this point in the history

  5. Older migration section: typo + rephrase

    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    e6b19a5 View commit details
    Browse the repository at this point in the history

  6. More readable link

    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    ca7203d View commit details
    Browse the repository at this point in the history

  7. Merge remote-tracking branch 'origin/add-schema-migration-guide' into… 

    … documentation-for-ui
    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    0a27702 View commit details
    Browse the repository at this point in the history

  8. Fix ref name

    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    5c763ab View commit details
    Browse the repository at this point in the history

  9. Merge remote-tracking branch 'origin/master' into documentation-for-ui

    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    ecbc33e View commit details
    Browse the repository at this point in the history

  10. Line length, fix UI home page

    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    bc4c6c8 View commit details
    Browse the repository at this point in the history

  11. rv sdl

    @Dhghomon
    Dhghomon committed Jan 23, 2024
    Configuration menu
    Copy the full SHA
    957fcf6 View commit details
    Browse the repository at this point in the history

Commits on Jan 29, 2024

  1. Better query editor image

    @Dhghomon
    Dhghomon committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    d51279f View commit details
    Browse the repository at this point in the history

  2. Add content + rephrase

    @Dhghomon
    Dhghomon committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    4c8ab19 View commit details
    Browse the repository at this point in the history

Commits on Jan 30, 2024

  1. Change Auth maxdepth to 1

    @Dhghomon
    Dhghomon committed Jan 30, 2024
    Configuration menu
    Copy the full SHA
    da3ed34 View commit details
    Browse the repository at this point in the history

  2. Rewrite with use case in mind, mention CLI REPL

    @Dhghomon
    Dhghomon committed Jan 30, 2024
    Configuration menu
    Copy the full SHA
    461890d View commit details
    Browse the repository at this point in the history

  3. +Note on confirmation dialog

    @Dhghomon
    Dhghomon committed Jan 30, 2024
    Configuration menu
    Copy the full SHA
    d221ea8 View commit details
    Browse the repository at this point in the history

  4. Update docs/ui/editor.rst 

    Co-authored-by: Scott Trinh <scott@edgedb.com>
    @Dhghomon @scotttrinh
    Dhghomon and scotttrinh committed Jan 30, 2024
    Configuration menu
    Copy the full SHA
    0fd58ec View commit details
    Browse the repository at this point in the history

  5. Merge branch 'documentation-for-ui' of https://github.com/edgedb/edgedb… 

    … into documentation-for-ui
    @Dhghomon
    Dhghomon committed Jan 30, 2024
    Configuration menu
    Copy the full SHA
    e257b9d View commit details
    Browse the repository at this point in the history

Commits on Feb 7, 2024

  1. Apply suggestions from code review 

    Co-authored-by: Devon Campbell <devon@edgedb.com>
    @Dhghomon @raddevon
    Dhghomon and raddevon committed Feb 7, 2024
    Configuration menu
    Copy the full SHA
    e62ab97 View commit details
    Browse the repository at this point in the history

  2. Line length, rv commas

    @Dhghomon
    Dhghomon committed Feb 7, 2024
    Configuration menu
    Copy the full SHA
    cd576d3 View commit details
    Browse the repository at this point in the history

Commits on Feb 8, 2024

  1. Test WSL clock

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    4229106 View commit details
    Browse the repository at this point in the history

  2. Auth guide link fix

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    3529393 View commit details
    Browse the repository at this point in the history

  3. More images

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    0d309ac View commit details
    Browse the repository at this point in the history

  4. Move schema viewer image down

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    cda8a5f View commit details
    Browse the repository at this point in the history

  5. +stdlib search result image

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    624c5d5 View commit details
    Browse the repository at this point in the history

  6. Replace ui_repl image

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    9cbdbc6 View commit details
    Browse the repository at this point in the history

  7. Change alt text

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    a8167b4 View commit details
    Browse the repository at this point in the history

  8. Change client_settings to gif

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    569fdd0 View commit details
    Browse the repository at this point in the history

  9. delete old client_settings.png

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    b4ccc57 View commit details
    Browse the repository at this point in the history

  10. fix: output from REPL, not REPL itself

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    7dcf053 View commit details
    Browse the repository at this point in the history

  11. Rely on image alone, add more alt text

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    eb6f8e7 View commit details
    Browse the repository at this point in the history

  12. Rework images

    @raddevon
    raddevon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    ea8a22b View commit details
    Browse the repository at this point in the history

  13. Add screenshot of schema selection dropdown menu

    @raddevon
    raddevon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    64b21a3 View commit details
    Browse the repository at this point in the history

  14. Use sentence case for headings/titles 

    for consistency across docs
    @raddevon
    raddevon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    2b66025 View commit details
    Browse the repository at this point in the history

  15. "UI Home" -> "Instance dashboard" 

    to more explicitly reflect contents of this view
    @raddevon
    raddevon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    e9ae062 View commit details
    Browse the repository at this point in the history

  16. "Editor" -> "Query editor" 

    to be less ambiguous
    @raddevon
    raddevon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    cb30a0c View commit details
    Browse the repository at this point in the history

  17. Update names in TOC

    @raddevon
    raddevon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    6106d82 View commit details
    Browse the repository at this point in the history

  18. "Dashboard" -> "Database dashboard" 

    to disambiguate with "Instance dashboard"
    @raddevon
    raddevon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    12a01a7 View commit details
    Browse the repository at this point in the history

  19. For better consistency within the UI docs 

    where we are not quoting the names of other UI labels
    @raddevon
    raddevon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    a4c63d7 View commit details
    Browse the repository at this point in the history

  20. Add alt title 

    to avoid any ambiguity between the CLI REPL and the UI REPL when a user
is looking at this page
    @raddevon
    raddevon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    6541cab View commit details
    Browse the repository at this point in the history

  21. Update JS docs link to a relative link 

    Links by label name don't seem to work across repos
    @raddevon
    raddevon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    4e13fa9 View commit details
    Browse the repository at this point in the history

  22. Switch to two code blocks for output

    @Dhghomon
    Dhghomon committed Feb 8, 2024
    Configuration menu
    Copy the full SHA
    83d110a View commit details
    Browse the repository at this point in the history