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.

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

Restructure Lab docs #1182

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

Restructure Lab docs #1182

wants to merge 28 commits into from

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

Sorry, something went wrong.

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 10, 2025 11:39am

* 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>
* update query modules

* resolve comments

* update
matea16 and others added 2 commits April 8, 2025 14:04
* update lab docs

* update content
* Add Lab fixes/todos

* update installation and deployment

* update collections

* update gss

* update sso

* update sharing features and config

* update enterprise flow

* updates

* update enterprise flow
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)

-p 3000:3000 \
-e ENTERPRISE_LICENSE_ORG_NAME="My company" \
-e ENTERPRISE_LICENSE_KEY="key..." \
memgraph/lab
```

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Once you've added the enterprise license key and organization name, and if everything is configured correctly, you should see the following log message from Memgraph Lab:
\`\`\`
INFO: Enterprise license applied successfully. Enjoy the premium features.
\`\`\`

Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure how to add backtick in the suggestion so that it doesn't close the suggestion.

Comment on lines +15 to +18
By selecting a certain node or relationship type, Memgraph Lab will provide
information about the current number of nodes or relationships of that type, as
well as the percentage of existence of each property across the nodes and
relationships of that type.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
By selecting a certain node or relationship type, Memgraph Lab will provide
information about the current number of nodes or relationships of that type, as
well as the percentage of existence of each property across the nodes and
relationships of that type.
By selecting a certain node or relationship type, Memgraph Lab will provide
information about the current number of nodes or relationships of that type, as
well as the percentage of existence of each property across the nodes and
relationships of that type.
If you're connected to a Memgraph instance running with the `--schema-info-enabled` configuration flag, you'll see the types for each node and relationship property.

@@ -56,8 +56,8 @@ Detailed instructions to get users started with GraphChat.

### Prerequisites

1. Ensure you have Memgraph and MAGE installed.
2. You have prepared and imported your data into Memgraph.
1. Ensure you have Memgraph and MAGE [installed](/getting-started/install-memgraph).
Copy link
Contributor

Choose a reason for hiding this comment

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

Not anymore. This is from the app:

To give you the best possible results, GraphChat requires Memgraph procedures to generate graph schema. Memgraph v2.16.0 or above is required

We removed the llm_util dependency and GraphChat will use:

  • SHOW SCHEMA INFO if available
  • schema procedure if exists (e.g. schema.rel_type_properties)
  • Cypher queries as a last resort

@@ -0,0 +1,64 @@
---
title: Run history
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to mention somewhere on this page that the run history is saved locally in the browser, so any new browser instance will have a fresh state?

[Configuration](/memgraph-lab/configuration) documentation to learn how to
configure Memgraph Lab using environment variables.

### Custom base path
Copy link
Contributor

Choose a reason for hiding this comment

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

I am thinking if SSL and BASE_PATH should be subpages of the installation and deployment, especially now when we will be adding CONFIG for settings, node actions, datasets, etc.

is the standard method for running complete Cypher queries and retrieving
results from the database.​

Once you **Run** a query (by clicking a button or pressing **CTRL** +
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Once you **Run** a query (by clicking a button or pressing **CTRL** +
Once you **Run** a query (by clicking a button or pressing **CTRL/CMD** +

Comment on lines +259 to +261
Another interesting feature you can use on graph data results is the map
background. This feature automatically turns on when the result nodes have
numeral `lat` and `lng` properties.
Copy link
Contributor

Choose a reason for hiding this comment

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

We could also add:


If latitude and longitude data are not stored in the default lat and lng properties, you can use a Graph Style Script (GSS) to map alternative fields for location tracking. For example:

// nodes have .latitude and .longitude fields
Define(LATITUDE_FIELD, "latitude")
Define(LONGITUDE_FIELD, "longitude")

// In the case of numeric latitude and longitude properties, set them up for a switch to a map view
@NodeStyle And(IsNumber(Property(node, LATITUDE_FIELD)), IsNumber(Property(node, LONGITUDE_FIELD))) {
  latitude: Property(node, LATITUDE_FIELD)
  longitude: Property(node, LONGITUDE_FIELD)
}

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.

None yet

3 participants