Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@neo4j/docs-ui",
"version": "0.23.3",
"version": "0.23.8",
"description": "Produces the UI bundle for the Neo4j documentation site",
"homepage": "https://github.com/neo4j-documentation/docs-ui",
"license": "MPL-2.0",
Expand Down
124 changes: 124 additions & 0 deletions preview-src/contribute.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
= Contributing to Neo4j
:page-layout: center-align
:author: Neo4j
:category: development
:tags: community, contributions, share

[#neo4j-contribute]
Looking for a place to contribute to the Neo4j ecosystem?
This is a great place to start.
Here you will find guides from Neo4j’s community of contributors.

[#finding-help]
== Help Others in the Community

Want to help others?

There are a number of great resources the Neo4j community uses to get quick help from graph database experts.
Don't hesitate to ask when you’re stuck and looking for help. Also, if you're familiar with a particular topic area, please jump in and lend a hand for your fellow graphistas.

The primary home for Neo4j community discussion is our https://community.neo4j.com[Neo4j Forum^].

We also have some other places the community asks questions.

* http://stackoverflow.com/questions/tagged/neo4j[Neo4j on StackOverflow^]
* http://twitter.com/neo4j[Social: Neo4j on Twitter^]
* https://discord.gg/neo4j[Discord Chat^]
* http://github.com/neo4j/neo4j/issues[Raise Issues: GitHub Issues^]

[#ask-question-tips]
== Tips for Asking Good Questions

If you have technical questions, we would love to help you find the answers to them! Please help us help you by following the guidelines below.

*Write a title that summarizes the specific problem* +
The title may be the first and the last thing that potential viewers see of your post.
Make it count. Make it describe the problem, not your current state of mind.
ALL CAPS and lots of question and exclamation marks are an indication that you wear your underwear on your head ??? not that you have an urgent problem !!!

*Choose the correct "category" and add the relevant "tags"* +
Both of these serve to narrow down the problem area.
A database creation error on the "Neo4j Desktop" is quite possible, it is almost impossible if installed with a Yum package.
For installation questions specifying the OS is definitely useful. And so on.

*Explain First* +
What do you want to accomplish? What is the problem?
What have you tried (you have tried something, right...right?)?
Can you reproduce the situation? Which steps need to be followed to get there?

*Code Second* +
For some weird reason, Verdana 12pt does horrible things to code.
There are a ton of ways to add readable code in your posts, the easiest is to select it and use the </> preformatted text icon.
Reading hundreds of lines of code and Cypher-queries is the favorite hobby of most of the visitors of the forum.
Just in case it is one of the others that is trying to help you, provide the code that demonstrates the issue and no more.

*Proofread* +
Are you ready to press "Create"? Take a deep breath. Exhale.
Go once more over what you've just written. Does it look like the kind of question you could answer?

*I'm not sure my English is good enough...can I get help?* +
Just do the best you can! While technical questions should be in English, there are Local Groups on the forum.
Not only are those good for finding out about local activities, but there might be somebody else there that knows (for example) South-West England English and can help you translate it into six o'clock news English!

*Be Patient - Be Friendly - Be Polite - Help someone else in turn* +
Somebody is going to spend some of the single most valuable resources for a human on your question. Time.
Giving an indication that you understand the value of that is the least you can do.

[#speaking]
== Sharing your Love of Graphs

No matter where you live in the world, there are plenty of ways to share your love of graphs
and help others understand the importance of relationships.

With thousands of technology and business *conferences* occuring every year around the world,
you can present to your peers and become a recognized expert in your field. Neo4j, via the
link:/speaker-program/[*Neo4j Speaker Program*], can also help and reimburse
travel expenses for community members speaking at many of the top conferences.

There are also hundreds of face-to-face https://www.meetup.com/topics/neo4j/[*Neo4j meetup groups*] in communities
around the world. Many of these meetup groups regularly look for speakers to share their stories.

The https://www.meetup.com/Neo4j-Online-Meetup/[*Neo4j Online Meetup*] is a way for you to meet the global community online and share your story.

We select talks for the Online Meetup and stories for our link:/tag/twin4j/[*Developer Newsletter*] from https://community.neo4j.com/[*Neo4j Community Forum*]. To submit your story, post it in the `Projects & Collaboration` (if including a link to github or website) or `Community Content & Blogs` (if linking to a blog post,
slideshow, video, or article) categories.

[#contributing]
== Other Ways to Contribute

The Neo4j project is an open source effort to bring fast, complex data storage and processing to life.
Every form of help is highly appreciated by the community.
Note that you can contribute to Neo4j also by providing documentation or giving feedback on the current documentation.
Basically, in all the places where you can get help, there is also room for contributions.

* link:/developer/contributing-code/[Contributing Code^]
* link:/developer/cla/[Contributors License Agreement^]
* GitHub http://github.com/neo4j/neo4j/issues[Issues^] and http://github.com/neo4j/neo4j/pulls[Pull Requests^]
* See the https://github.com/neo4j/neo4j/graphs/contributors[list of contributors^]

[#develop-neo4j]
== Tools for Developing Neo4j

We are happy users of the following tools that we use daily to develop Neo4j.

* IDE: https://www.jetbrains.com/idea/[IntelliJ Idea by JetBrains^] - *Thank you so much for the https://www.jetbrains.com/idea/buy/choose_edition.jsp?license=OPEN_SOURCE[OSS license^]!* and Eclipse
* Build System: https://www.jetbrains.com/teamcity/[TeamCity by JetBrains^] - *Thank you so much for the https://www.jetbrains.com/teamcity/buy/choose_edition.jsp?license=OPEN_SOURCE[OSS license^]!*
* Profiler: Yourkit, VisualVM, jvmtop, Java Mission Control, Flight Recorder
* Version Control: Git & http://github.com/neo4j[GitHub^]
* Issue Management: Trello and http://github.com/neo4j/neo4j/issues[GitHub issues^]
* Team Communication: Neo4j Community Site, Discord, Google Hangouts, and Zoom
* Pair Programming: Team Viewer, join.me
* Documents: Google Docs
* Manual, GraphGists, Presentations: http://asciidoctor.org[AsciiDoctor^]
* Programming Language: Java, Build-Tool - Maven
* Libraries - JVM: Scala, Parboiled, Google Collections, JMH, Jetty, Jersey, Jackson, Apache Commons, JUnit
* Libs & Tools: Javascript: D3.js, Angular.js, Grunt, Bower

[#integration-dev]
== Tools, Libraries, and Drivers

Neo4j is supported by a rich ecosystem of libraries, tools, drivers and guides provided by partners, users and community contributors.
We want to give an overview about what is available and link to the original sources.
We try to focus on the freely available solutions here and provide links to commercial options where appropriate.

Read more about it in our link:/developer/integration/[Integrations section].
6 changes: 6 additions & 0 deletions preview-src/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -740,3 +740,9 @@ For more information, see the link:/ops-manual[Operations Manual^]
. Text <<test-links,testing link text styling>> text text.
. Text <<test-links,`testing link text styling monospace`>> text text.
. Text `<<test-links,testing link text styling monospace>>` text text.


== skip-to-content links
Link to a section down the page: link:#skip-to-content[]

+++<a class="show-on-focus skip-link" href="#skip-to-content" title="Skip to content">Skip to content</a>+++
39 changes: 39 additions & 0 deletions preview-src/links.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
= Links
:nofooter:
:neo4j-docs-base-uri: https://neo4j.com/docs

== angle brackets

<<to-docs, to docs!>>


== xref

xref:labs.adoc[]


[[to-docs]]
== link to neo4j.com/docs

internal: link:https://neo4j.com/docs[neo4j.com/docs]

external: link:https://neo4j.com/docs[neo4j.com/docs^]

attribute: link:{neo4j-docs-base-uri}[neo4j.com/docs]

attribute (external): link:{neo4j-docs-base-uri}[neo4j.com/docs^]


== link to neo4j.com

internal: link:https://neo4j.com[neo4j.com]

external: link:https://neo4j.com[neo4j.com^]


== link to example.com

internal: link:https://example.com[example.com]

external: link:https://example.com[example.com^]

6 changes: 6 additions & 0 deletions preview-src/ui-model.yml
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,9 @@ page:
- content: Feedback disabled
url: feedback-disabled.html
urlType: internal
- content: Links
url: links.html
urlType: internal
- content: Docs roles
url: docs-roles.html
urlType: internal
Expand Down Expand Up @@ -258,6 +261,9 @@ page:
- content: Category Pop Culture
url: graph-gist-category-pop-culture.html
urlType: internal
- content: Contribute
url: contribute.html
urlType: internal
# additional page attributes indexed by page-slug
pages-data:
cheatsheet-products: &cheatsheet-products
Expand Down
12 changes: 12 additions & 0 deletions src/css/body.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,15 @@
display: flex;
}
}

.show-for-sr,
.show-on-focus {
position: absolute !important;
width: 1px !important;
height: 1px !important;
padding: 0 !important;
overflow: hidden !important;
clip: rect(0, 0, 0, 0) !important;
white-space: nowrap !important;
border: 0 !important;
}
11 changes: 11 additions & 0 deletions src/css/center-align.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
body.center-align .toolbar {
justify-content: center;
}

body.center-align .content {
justify-content: center;
}

body.center-align .doc {
max-width: 1104px;
}
1 change: 1 addition & 0 deletions src/css/code.css
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,7 @@
.code-walkthrough .doc .listingblock code {
box-shadow: none;
border: 0 none !important;
tab-size: 2;
}

.code-walkthrough .toc {
Expand Down
14 changes: 10 additions & 4 deletions src/css/doc.css
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ body {
}

.doc h5 {
font-size: var(--doc-font-size-h6);
font-size: var(--doc-font-size-h5);
font-weight: 600;
margin-bottom: 0.5rem;
}

.doc h6 {
font-size: var(--doc-font-size-h6);
font-size: var(--doc-font-size-h5);
}

.doc h1 code,
Expand Down Expand Up @@ -175,11 +175,17 @@ body {
.doc a {
font-weight: 600;
color: var(--link-font-color);
/* border-bottom: 1px solid var(--link-font-color); */
/* text-decoration: none; */
text-decoration: underline;
}

.doc a:hover,
.doc a:hover code:hover {
.doc a:focus,
.doc a:hover code:hover,
.doc a:focus code:focus {
color: var(--link_hover-font-color);
/* border-bottom: 1px solid var(--link_hover-font-color); */
}

.doc a:visited {
Expand Down Expand Up @@ -1300,7 +1306,7 @@ body {
border: none;
}

.doc details {
.doc div > details {
margin-bottom: 1.5rem;
}

Expand Down
2 changes: 1 addition & 1 deletion src/css/kb.css
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ body.kb h2::after {

body.kb .label {
background-color: var(--color-kb) !important;
color: var(--color-kb);
color: rgba(var(--colors-neutral-15));
}

/* Hero */
Expand Down
5 changes: 5 additions & 0 deletions src/css/neo4j-docs.css
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@
4px 4px 4px 4px rgba(var(--colors-neutral-10));
}

.docs article .rounded-corners img,
.docs article video.rounded-corners {
border-radius: 15px;
}

.docs article .no-border img {
border: none;
padding: 0;
Expand Down
1 change: 1 addition & 0 deletions src/css/site.css
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
@import "labels.css";
@import "glossary.css";
@import "landing.css";
@import "center-align.css";
/* @import "tiles.css"; */
@import "docs-home.css";
/* @import "developer.css"; */
Expand Down
4 changes: 2 additions & 2 deletions src/css/vars.css
Original file line number Diff line number Diff line change
Expand Up @@ -297,8 +297,8 @@

/* links */
--link-font-color: rgba(var(--colors-baltic-50));
--link_hover-font-color: rgba(var(--colors-baltic-40));
--link_visited-font-color: var(--palette-categorical-8);
--link_hover-font-color: rgba(var(--colors-baltic-55));
--link_visited-font-color: rgba(var(--colors-neutral-60));
--link_unresolved-font-color: var(--important-color);

/* abstract */
Expand Down
17 changes: 0 additions & 17 deletions src/js/06-code.js
Original file line number Diff line number Diff line change
Expand Up @@ -283,23 +283,6 @@ document.addEventListener('DOMContentLoaded', function () {
el.classList.add(tabActive)
})
})

var toolbarOffset = 0
var toolbar = document.querySelector('.toolbar')
if (toolbar.offsetHeight) {
toolbarOffset = toolbar.offsetHeight
}
var offset = document.querySelector('.navbar').offsetHeight + toolbarOffset + 20

var bodyRect = document.body.getBoundingClientRect().top
var elementRect = tab.getBoundingClientRect().top
var elementPosition = elementRect - bodyRect
var offsetPosition = elementPosition - offset

window.scrollTo({
top: offsetPosition,
behavior: 'smooth',
})
}

// Tabbed code
Expand Down
17 changes: 0 additions & 17 deletions src/js/08-tabs-block.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,23 +63,6 @@ document.addEventListener('DOMContentLoaded', function () {
})
})

var toolbarOffset = 0
var toolbar = document.querySelector('.toolbar')
if (toolbar.offsetHeight) {
toolbarOffset = toolbar.offsetHeight
}
var offset = document.querySelector('.navbar').offsetHeight + toolbarOffset + 20

var bodyRect = document.body.getBoundingClientRect().top
var elementRect = tab.getBoundingClientRect().top
var elementPosition = elementRect - bodyRect
var offsetPosition = elementPosition - offset

window.scrollTo({
top: offsetPosition,
behavior: 'smooth',
})

if (sessionStorageAvailable) {
window.sessionStorage.setItem('code_example_language', lang)
}
Expand Down
Loading