-
Notifications
You must be signed in to change notification settings - Fork 12
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
base: main
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
* 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
* Add configuration * add todo
* add querying * update with images * update querying --------- Co-authored-by: katarinasupe <supe.katarina@gmail.com>
There was a problem hiding this 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)
@tonilastre I added most of your suggestions. 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). |
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.
Makes sense! |
|
Co-authored-by: Matea Pesic <80577904+matea16@users.noreply.github.com>
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. |
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. |
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.