neo4j-documentation/docs-ui

docs-ui's Issues

Reduce buttons CSS selector scope to avoid conflicts

Make collapse code blocks expandable by clicking anywhere on the block

Right now readers have to click on the Read more button explicitly - it would be nicer to be able to click anywhere in the code block area.

GraphAcademy, add visual indicator (pictogram/icon) when a question is incorrect

Using only a color is not helpful for colorblind or other people with visual deficiencies.
Here's how it looks today:

Use the "official" language name in the code header

• csharp -> C#
• xml -> XML
• csv -> CSV
• js -> JavaScript
• javascript -> JavaScript

If there's no explicit mapping, we should probably capitalize the first letter:

• java -> Java
• scala -> Scala
• python -> Python
• groovy -> Groovy
• cypher -> Cypher

I think conf and properties should remain in lowercase since they only refer to the file extension. Thoughts?

//cc @ElaineRosenberg

Escape title on GraphGist cards

Broken nested list layout in deep sidebar lists

https://neo4j.com/docs/upgrade-migration-guide/current/version-4/migration/drivers/drivers-changes/

It has something to do with li having data-depth = 5.

"undefined" result when queries create nodes on runnable block using GraphGist backend

A new GraphGist console was deployed and apparently the query response has changed:

Previously, the result was the "raw" query output from Neo4j.

Remove or replace prompt from the copy text in source block

Currently, we are using the following prompts in the documentation:

neo4j-home> echo "foo"

$ echo "foo"

neo4j> call dbms.cluster.overview() yield addresses, role;

(on Neo4j shell)

Changing location with version picker -> can't go back in browser

When switching version with the version dropdown, the browser's back button does not bring back to the previous version viewed, which in my expectations should.

Add Asciidoctor frame-* and grid-* styles

The frame and grid can be configured with Asciidoctor (read: https://mrhaki.blogspot.com/2014/11/awesome-asciidoctor-changing-grid-and.html)

Arguably, tables should not be used to layout elements but some documents are using them.
Here's the current rendering:

And here's the expected rendering:

For reference, here's the default Asciidoctor stylesheet: https://github.com/asciidoctor/asciidoctor/blob/cabde9c25fe040221ad71bb6aaf8754d2e5ec099/data/stylesheets/asciidoctor-default.css#L259-L269

Publish Intercom, Mixpanel and Google Analytics events on course/enrollment pages

Enrollment

https://github.com/neo4j-contrib/training-v3/blob/1d0b76bb983b3b2b443ba2614ef28cf0291cf212/resources/templates/enrollment/_enrollment.js#L78-L99

https://github.com/neo4j-contrib/training-v3/blob/1d0b76bb983b3b2b443ba2614ef28cf0291cf212/resources/templates/enrollment/_enrollment.js#L136-L168

Course

https://github.com/neo4j-contrib/training-v3/blob/1d0b76bb983b3b2b443ba2614ef28cf0291cf212/resources/templates/course/_quizzes.js#L296-L309

Version 9 of Highlight.js has reached EOL and is no longer supported

This comes up in the browser console

Version 9 of Highlight.js has reached EOL and is no longer supported.
Please upgrade or ask whatever dependency you are using to upgrade.
highlightjs/highlight.js#2877

Maintain scroll position in documentation index

Is your feature request related to a problem? Please describe.
I'm frustrated when I scroll down the docs content on the LHS, click on a section and the content section auto scrolls back to the top. This makes clicking through items in a particular section involve a lot of scrolling.

Describe the solution you'd like
Maintain scroll position of index after click

Describe alternatives you've considered
n/a
Additional context
Particularly relevant for APOC documentation which can have some very long sections

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

Here's a mockup:

"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://[email protected]
In this case, the value of the "Connection URL" field will be: neo4j+s://[email protected]

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.

Code blocks within lists don't get new style

They don't get the overlay with language/copy, nor the proper titling or collapsing.

- when a property list has multiple items, specify each property in a separate object within the list, and not as a single object containing them all.
+
.Good
[code, json]
----
"dates": [
  {"born": "born"},
  {"died": "died"}
]
----

Antora has built-in function to resolve a page

See if we can replace custom code with built-in resolvePage and/or resolvePageURL UI helpers.

Navigation toolbar is not properly implemented for responsive layout

The navigation is not properly aligned when "active".

If "active" and then into full screen, the navigation bar is miss placed.

Used chromium to check this.

Use a query cache on the source block component

The goal is to reduce the number of queries sent to Neo4j sandbox, aura and the GraphGists portal.

It should be possible to populate the cache from a query result generated at build time.
For instance, the GraphGists build could generate static files in the attachments directory that contain query results.

The source block component will then check if a file exists for a given couple page-query.

The source block component will use the cache when available. If not, it will switch to interactive mode and query the backend.

We could use a md5sum of the query as a unique key.

We can use https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage to save data.

Disable enrollment form when the attribute page-disable-enrollment is defined

Show a generic message instead of the enrollment form: "You cannot enroll in this course.".

Buttons with the class "course-action" on the GraphAcademy landing page should be pink

The following buttons should be pink:

When page-no-index is defined, configure noindex on googlebot and bingbot as well

Currently, the page-no-index attribute does not apply to googlebot or bingbot:

docs-ui/src/partials/head-prelude.hbs

Lines 5 to 12 in 1f2107f

	{{#if (ne page.attributes.no-index undefined) }}
	<meta name="robots" content="noindex" />
	{{else}}
	<meta name="robots" content="index, follow" />
	{{/if}}
	<meta name="googlebot" content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1" />
	<meta name="bingbot" content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1" />

We should probably fix the condition:

{{#if (ne page.attributes.no-index undefined) }}
  <meta name="robots" content="noindex" />
  <meta name="googlebot" content="noindex" />
  <meta name="bingbot" content="noindex" />
{{else}}
  <meta name="robots" content="index, follow" />
  <meta name="googlebot" content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1" />
  <meta name="bingbot" content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1" />
{{/if}}

`Run in Neo4j Browser` gives out no notice when Neo4j Desktop is not installed

The run buttons only have an effect if Neo4j Desktop is installed, as they go through the neo4j-desktop:// protocol. Not everybody has it, and as it currently stands it's impossible to know that that's a prerequisite. We should alert users when clicking, if the protocol is unavailable.

"Copy to clipboard" goes on two lines after clicking

"undefined" result on runnable block using Neo4j labs backend (default)

Requesting clarification (not an issue)

Hi,

I would like to customise and use this theme for our doc site. I would like to know if there are any restrictions for this.

Thank you!