new: Add query sharing docs and update ENV variables for Lab #865

tonilastre · 2024-06-25T07:30:56Z

Description

Add all new environment variables for the Lab. Add query-sharing feature page.

For the Lab release: Lab 2.15.

Pull request type

Please check what kind of PR this is:

Fix or improvement of an existing page
New documentation page, release related

Related PRs and issues

Checklist:

Check all content with Grammarly
Perform a self-review of my code
Make corresponding changes to the rest of the documentation (consult with the DX team)
The build passes locally
My changes generate no new warnings or errors
Add a corresponding label
If release-related, add a product and version label
If release-related, add release note on product PR

vercel · 2024-06-25T07:30:59Z

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	Jul 3, 2024 7:58am

kgolubic

I've made some updates to styling so that Vercel build can pass. I've also made some minor language changes. Everything looks good to me.

hal-eisen-MG · 2024-06-26T01:38:37Z

pages/data-visualization/install-and-connect.mdx

+| `AUTH_SAML_OKTA_ISSUER`                  | Okta SAML issuer                                                        | `string`   |                    |
+| `AUTH_SAML_OKTA_SIGNATURE_ALGORITHM`     | Okta SAML signature algorithm                                           | `string`   | `"sha256"`         |
+| `ENTERPRISE_LICENSE_ORG_NAME`            | Enterprise license organization name                                    | `string`   |                    |
+| `ENTERPRISE_LICENSE_KEY`                 | Enterprise license key                                                  | `string`   |                    |


Mention something about "contact our Sales team via XYZ to purchase a key"

Actually, I am thinking about adding a link for both ENV variables to https://memgraph.com/docs/database-management/enabling-memgraph-enterprise - it seems better to have one page that describes the enterprise rather than to have "copy" of that description in multiple places. The enterprise link also has a link to request a license or trial.

hal-eisen-MG · 2024-06-26T01:38:55Z

pages/data-visualization/install-and-connect.mdx

+| `AUTH_SAML_OKTA_CALLBACK_URL`            | Okta SAML callback URL                                                  | `string`   |                    |
+| `AUTH_SAML_OKTA_ISSUER`                  | Okta SAML issuer                                                        | `string`   |                    |
+| `AUTH_SAML_OKTA_SIGNATURE_ALGORITHM`     | Okta SAML signature algorithm                                           | `string`   | `"sha256"`         |
+| `ENTERPRISE_LICENSE_ORG_NAME`            | Enterprise license organization name                                    | `string`   |                    |


Explain the significance of this variable

Currently, I added a link to the enterprise license documentation. Maybe it makes sense to add everything about the license there to have it in one place.

This is the only link I've found: https://memgraph.com/docs/database-management/enabling-memgraph-enterprise

hal-eisen-MG · 2024-06-26T01:42:07Z

pages/data-visualization/user-manual/query-sharing.mdx

+will be able to handle their own query shares.
+
+If there are no users in the Memgraph database, then anyone connecting
+to Memgraph acts as the same user (not defined one) so everyone can


s/not defined one/Not-Defined user

hal-eisen-MG · 2024-06-26T01:43:53Z

pages/data-visualization/user-manual/query-sharing.mdx

+When a viewer clicks on the query share link, the viewer will need
+to connect to Memgraph first and will be presented with the query
+to run. This way, any sensitive information within your query or
+parameters are not shared publicly but contained within the Lab and


s/but contained/but rather are safely contained

hal-eisen-MG · 2024-06-26T01:45:48Z

pages/data-visualization/user-manual/query-sharing.mdx

@@ -0,0 +1,110 @@
+---


Is it possible to LIST all queries which have been stored for sharing?

Is it possible to EDIT an existing shared query?

Please address both questions in the doc. If answer is "no", then explain about possible future expansion of the feature.

tonilastre · 2024-06-27T22:43:12Z

I've updated Query sharing docs and added all the reported fixes.

Note: In the query sharing docs I've added TODO parts where images and/or video should be added, some are sketches, and some are screenshots. Please consult with Ana and the team for them to have them ready by Wed.

…aph/documentation into new/add-query-sharing-docs

* Docs improvements (#799) * Add NuRaft log file flag (#816) * Add health checks docs (#833) * Update HA examples * Add NuRaft log file env (#848) * Add leader/follower role (#857) Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com> * Add coordinator hostname HA configuration option (#860) * First leader * Update pages/clustering/high-availability.mdx Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com> --------- Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com> * Add monitoring at runtime docs (#806) * database-less connections update (#853) * Update HA docs * Add durability for coordinator (#859) * add durability docs * Update high-availability.mdx --------- Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> * Edge type property index (#855) * Add hops limit docs (#881) * add docs for hops limit * revert accidentally changed part of the docs * fix grammar mistakes * implement suggestions * Peak memory observation in the system (#788) * Peak memory observation in the system * Update storage info where needed * Update best practics * Add information from PR review --------- Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> * removed flags (#854) * Update envs for HA (#878) * fix envs * add 3 missing envs * Update configuration.mdx * Update configuration.mdx --------- Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> * Add callout for important force reset notice (#877) * add callout for instance to be alive on force reset * Update high-availability.mdx * Enum datatype (v1) (#852) * Add information around enums * Add ALTER to the list of clauses * Add ALTER to the list of Memgraph's Cypher extension * Fix incorrect ALTER command * Update pages/querying/clauses/create.mdx * Update pages/querying/clauses/alter.mdx * Update pages/querying/clauses/alter.mdx * Update graph-modeling.md * Address PR comments --------- Co-authored-by: kgolubic <kgolubic@gmail.com> Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> * SSO Core - OIDC + OAuth2.0 docs (#876) * wip oidc docs * oidc sso docs * PR changes and update * update package info * add startup info * Update v2.18 experimental feature statuses (#871) * Update v2.18 experimental feature statuses * Join the sentances into paragraphs * Update language and formatting --------- Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> Co-authored-by: kgolubic <kgolubic@gmail.com> * Add postgresql migration docs (#867) * Add postgresql migration docs * Fix from PR review * Single-sign on: general and SAML documentation (#884) * Update the existing auth flags for v2.18 * Add a usage note for streams and triggers created by SSO users * Update general (other than the SAML modules) auth functionalities * Reorganize auth documentation to accommodate SSO * Add SAML SSO docs (partial) * Complete SAML docs * Apply review suggestions * Add remaining review suggestions * Move OIDC docs next to SAML (since both are SSO) * Fix trigger/stream × SSO usage note placement * Remove duplicate entry and fix section tag * Move section to the right place * Apply suggestions * Update direct download paths (#885) * Migration tutorial from `RDBMS` using `MAGE` modules (#770) * Memgraph 2.17 docs * Docs * Zoned datetime data type (#723) * Document how zoned datetime is supported * Fix formatting * Update the Differences in Cypher implementation page * Update min/max functions * Revert "Zoned datetime data type (#723)" (#763) This reverts commit 16c8157. * Add migration tutorial from rdbms to memgraph * Add fixes * Fix from PR review --------- Co-authored-by: kgolubic <kgolubic@gmail.com> Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> Co-authored-by: Ante Pušić <ante.pusic@memgraph.io> * new: Add query sharing docs and update ENV variables for Lab (#865) * new: Add a complete list of ENV variables * new: Add query-sharing feature page * Fix styling issues * Update query-sharing.mdx * new: Add more details for the query sharing * Add images * Insert images * Insert images * Fix paths --------- Co-authored-by: kgolubic <kgolubic@gmail.com> Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> * Added description how each user can change its own password (#819) * Added description how each user can change its own password * Update users.mdx * Update users.mdx --------- Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> * Add SSO docs (#797) * Add docs for OAuth setup (WIP) * Add docs for Okta OAuth * Replace references to OAuth with OIDC * Update single-sign-on.mdx * new: Add SAML for Entra and Okta --------- Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> Co-authored-by: Toni Lastre <toni.lastre@memgraph.io> * Create release notes for Memgraph 2.18 (#795) * Update release notes * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update RN * Update PR * Update RN * new: Add Lab 2.15 release notes (#866) * new: Add Lab 2.15 release notes * Update pages/release-notes.mdx --------- Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com> * Update RN * Update RN --------- Co-authored-by: Toni <toni.lastre@memgraph.io> * Remove support for Amazon Linux 2, CentOS 7 and RedHat 8 * Linked MAGE docs * Update release notes * Add callout for Breaking changes * Add PR link * Update Release notes * Update pages/database-management/authentication-and-authorization/auth-system-integrations.mdx Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com> * Fix indentation --------- Co-authored-by: Andi <andi8647@gmail.com> Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com> Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com> Co-authored-by: Josipmrden <josip.mrden@memgraph.io> Co-authored-by: andrejtonev <29177572+andrejtonev@users.noreply.github.com> Co-authored-by: Aidar Samerkhanov <aidar.samerkhanov@memgraph.io> Co-authored-by: David Ivekovic <david.ivekovic@memgraph.io> Co-authored-by: Gareth Andrew Lloyd <gareth@ignition-web.co.uk> Co-authored-by: Ivan Milinović <44698587+imilinovic@users.noreply.github.com> Co-authored-by: Marko Budiselić <marko.budiselic@memgraph.com> Co-authored-by: Ante Pušić <ante.pusic@memgraph.io> Co-authored-by: Toni <toni.lastre@memgraph.io> Co-authored-by: tonijurjevic96 <168409767+tonijurjevic96@users.noreply.github.com> Co-authored-by: David <davidlozic@gmail.com>

tonilastre added 2 commits June 24, 2024 18:13

new: Add a complete list of ENV variables

307e848

new: Add query-sharing feature page

a906469

tonilastre added the status: ready PR is ready for review label Jun 25, 2024

tonilastre self-assigned this Jun 25, 2024

tonilastre requested review from kgolubic and hal-eisen-MG as code owners June 25, 2024 07:30

vercel bot had a problem deploying to Preview June 25, 2024 07:31 Failure

Fix styling issues

b5f5881

vercel bot deployed to Preview June 25, 2024 09:54 View deployment

Update query-sharing.mdx

0bc604f

kgolubic approved these changes Jun 25, 2024

View reviewed changes

vercel bot deployed to Preview June 25, 2024 10:00 View deployment

hal-eisen-MG reviewed Jun 26, 2024

View reviewed changes

kgolubic added the future release For one of the next versions label Jun 26, 2024

new: Add more details for the query sharing

8f78fdb

tonilastre changed the title ~~New/add query sharing docs~~ new: Add query sharing docs and update ENV variables for Lab Jun 27, 2024

vercel bot deployed to Preview June 27, 2024 22:45 View deployment

kgolubic added 2 commits July 3, 2024 09:24

Add images

1d1da4b

Merge branch 'new/add-query-sharing-docs' of https://github.com/memgr…

a63ef6e

…aph/documentation into new/add-query-sharing-docs

vercel bot deployed to Preview July 3, 2024 07:29 View deployment

kgolubic added 2 commits July 3, 2024 09:34

Insert images

20c6533

Insert images

f9d3934

vercel bot deployed to Preview July 3, 2024 07:38 View deployment

Merge branch 'main' into new/add-query-sharing-docs

2f012d5

kgolubic changed the base branch from main to memgraph-2-18 July 3, 2024 07:40

Merge branch 'memgraph-2-18' into new/add-query-sharing-docs

9cd7ab3

vercel bot deployed to Preview July 3, 2024 07:47 View deployment

Fix paths

357633c

vercel bot deployed to Preview July 3, 2024 07:58 View deployment

kgolubic merged commit 1f5de34 into memgraph-2-18 Jul 3, 2024
2 checks passed

kgolubic deleted the new/add-query-sharing-docs branch July 3, 2024 08:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

new: Add query sharing docs and update ENV variables for Lab #865

new: Add query sharing docs and update ENV variables for Lab #865

tonilastre commented Jun 25, 2024 •

edited

Loading

vercel bot commented Jun 25, 2024 •

edited

Loading

kgolubic left a comment

hal-eisen-MG Jun 26, 2024

tonilastre Jun 27, 2024

hal-eisen-MG Jun 26, 2024

tonilastre Jun 27, 2024

hal-eisen-MG Jun 26, 2024

hal-eisen-MG Jun 26, 2024

hal-eisen-MG Jun 26, 2024 •

edited

Loading

tonilastre commented Jun 27, 2024

new: Add query sharing docs and update ENV variables for Lab #865

new: Add query sharing docs and update ENV variables for Lab #865

Conversation

tonilastre commented Jun 25, 2024 • edited Loading

Description

Pull request type

Related PRs and issues

Checklist:

vercel bot commented Jun 25, 2024 • edited Loading

kgolubic left a comment

Choose a reason for hiding this comment

hal-eisen-MG Jun 26, 2024

Choose a reason for hiding this comment

tonilastre Jun 27, 2024

Choose a reason for hiding this comment

hal-eisen-MG Jun 26, 2024

Choose a reason for hiding this comment

tonilastre Jun 27, 2024

Choose a reason for hiding this comment

hal-eisen-MG Jun 26, 2024

Choose a reason for hiding this comment

hal-eisen-MG Jun 26, 2024

Choose a reason for hiding this comment

hal-eisen-MG Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

tonilastre commented Jun 27, 2024

tonilastre commented Jun 25, 2024 •

edited

Loading

vercel bot commented Jun 25, 2024 •

edited

Loading

hal-eisen-MG Jun 26, 2024 •

edited

Loading