Skip to content

Restructure Lab docs & Lab 3.2 #1182

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.

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

Open
wants to merge 35 commits into
base: main
Choose a base branch
from
Open

Conversation

katarinasupe
Copy link
Contributor

@katarinasupe katarinasupe commented Mar 7, 2025

Memgraph Lab documentation has been fully restructured with the goal of providing better readability and developer experience. Also, this eases the process for future contributions to the Memgraph Lab docs. The changes involve flow updates, as well as adding new content and updating the existing one.
Redirects have been updated as well.

  • Is it okay to call this page section Memgraph Lab and where should it live on the left-hand side menu?
  • Add new images from design

Copy link

vercel bot commented Mar 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 18, 2025 0:56am

* update deployment and installation

* add content

* remove bolds

* update

---------

Co-authored-by: katarinasupe <supe.katarina@gmail.com>
* add data import docs

* update

---------

Co-authored-by: katarinasupe <supe.katarina@gmail.com>
* Add collections feature

* update

* update after review
katarinasupe and others added 2 commits April 4, 2025 16:46
* add querying

* update with images

* update querying

---------

Co-authored-by: katarinasupe <supe.katarina@gmail.com>
Copy link
Contributor

@tonilastre tonilastre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the new structure and the main page name being "Memgraph Lab". You did a great job in structuring the docs and filling out missing information (e.g. run history, collections, streams, ...).

I've added some comments as additional context to the existing content.

I was also thinking if users would benefit with some sort of F.A.Q that would have a lot of Callouts from these pages, e.g.:

  • A note about host.docker.internal
  • Netoworking around docker-compose and service naming
  • Copy/paste allow list in the browser
  • ...
  • (other common issues)

@katarinasupe
Copy link
Contributor Author

@tonilastre I added most of your suggestions.
For FAQ, not sure if it should be a separate FAQ, or if we should add Memgraph Lab section here: https://memgraph.com/docs/help-center/faq and link to it from the Lab docs? Wdyt? Otherwise, I like the suggestion.

Regarding subpages vs sections of installation and deployment, let's have them as sections first so we can see how they look and if it's "too much" we can add subpage. I just want to avoid branching that deep, as we try to keep it up to max level 3 across the docs (it's not always successful).

@tonilastre
Copy link
Contributor

@tonilastre I added most of your suggestions. For FAQ, not sure if it should be a separate FAQ, or if we should add Memgraph Lab section here: https://memgraph.com/docs/help-center/faq and link to it from the Lab docs? Wdyt? Otherwise, I like the suggestion.

I like this FAQ, + it has titles and sections, so it can be grouped under Memgraph Lab. Re: FAQ, lately I was looking for a notice on how to configure Chrome to allow copy/paste, and it was hard to find it because it was somewhere in the getting started (old documentation). I feel like there are several of these special case things that should be easily found and referenced - FAQ.

Regarding subpages vs sections of installation and deployment, let's have them as sections first so we can see how they look and if it's "too much" we can add subpage. I just want to avoid branching that deep, as we try to keep it up to max level 3 across the docs (it's not always successful).

Makes sense!

@Ana-Marija-design
Copy link

Getting Started / 2nd layer, overview page

  • Installation and deployment (intro) subsection → Link behaviour discrepancy

    • Docker and Desktop app links lead to documentation section with more information
    • Public Shared Lab [links to actual browser lab](https://lab.memgraph.com/login) → I think the behaviour should be the same as above, i.e. leading to documentation with more information. If we want to link directly to Lab, I’d go about it a different way, e.g.
      • [Public shared](https://lab.memgraph.com/) (leads to documentation)
        A pre-deployed version of Memgraph Lab (turn this into link to actual browser version), accessible in the browser for connecting to public Memgraph instances without installation.
  • Data migration section → 💡 should definitely be switched to ℹ️ and blue (though to be fair I kinda think this about most yellow callouts)

Querying

  • Query Status bar → I wonder if we should include an example of multiple queries being run, because the status bar then allows for query selection to review status of each query separately. [Figma reference here.](https://www.figma.com/design/Cb6e7VUWplFOCKmNX7swXi/Lab-2.0.?node-id=2599-26929&t=Reokw5hnQBq713ap-4)

  • Parameters → I think I should create a new visual, where I can include annotations (just to cover the fact that the tab also has an indicator of the number of parameters defined within it) -> obviously not high priority

  • monitoring → I think we should emphasize it monitors only during an active lab session

Co-authored-by: Matea Pesic <80577904+matea16@users.noreply.github.com>
@katarinasupe
Copy link
Contributor Author

@Ana-Marija-design

Installation and deployment (intro) subsection → Link behaviour discrepancy

Actually, this was on purpose. The goal was not to emphasize the public shared lab as we don't want people to use it as much.

@katarinasupe
Copy link
Contributor Author

@Ana-Marija-design

Parameters → I think I should create a new visual, where I can include annotations (just to cover the fact that the tab also has an indicator of the number of parameters defined within it) -> obviously not high priority

Leaving this one to you -> if you generate new image send it to me.

Other is resolved or commented above. Image for multiple queries will be added once created.

@katarinasupe katarinasupe changed the title Restructure Lab docs Restructure Lab docs & Lab 3.2 Apr 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants