neo4j-documentation / docs-ui

Mozilla Public License 2.0
4 stars 23 forks source link

Add an input below the "Play as Browser Guide" button to configure the connection URL (to the database) #79

Closed ggrossetie closed 2 years ago

ggrossetie commented 2 years ago

Here's a mockup:

image

"Database URL" should be renamed "Connection URL".

The default value of "Connection URL" field will be: bolt://localhost.

If the query string dbms is defined, we will use this value instead of the default value. For instance: https://neo4j.com/graphgists/northwind-recommendation-engine/?dbms=neo4j%2Bs://neo4j@foo.databases.neo4j.io In this case, the value of the "Connection URL" field will be: neo4j+s://neo4j@foo.databases.neo4j.io

The connection URL will be used to update the link on the "Play as Browser Guide" button:

https://browser.neo4j.io/?cmd=play&arg=https://guides.neo4j.com/graph-examples/northwind-recommendation-engine/graph_guide&dbms={{connectionUrl}}

As you can see, the value of the field "Connection URL" is passed as a query string: &dbms={{connectionUrl}} (where {{connectionUrl}} is the connection URL filled out by the user).

Please note that we are now using https://browser.neo4j.io instead of neo4j-desktop://graphapps/neo4j-browser.

//cc @adam-cowley let me know what you think since you've worked on the original design.

adam-cowley commented 2 years ago

It looks OK in principle but I think I'd rather have Play as Browser Guide as a heading, then an input box for the URL and a button that says Play next to it. That way there is a clearer connection between the input box and the button

I'm also wondering if play is the best terminology for this too - maybe it should be Open in Neo4j Browser instead?

adam-cowley commented 2 years ago

While you have it open, could you also add some padding to the top of the Industries and Use Cases headers and around the button group please? 1em maybe? šŸ˜‡

ggrossetie commented 2 years ago

Great suggestions, will do šŸ‘šŸ»

I'm also wondering if play is the best terminology for this too - maybe it should be Open in Neo4j Browser instead?

No strong opinion but a slight preference toward "Open in Neo4j Browser".