Skip to content

Commit cf3463b

Browse files
committedAug 28, 2020
initial project setup
0 parents  commit cf3463b

File tree

12 files changed

+4285
-0
lines changed

12 files changed

+4285
-0
lines changed
 

‎.github/workflows/main.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Trigger Publish
2+
3+
on:
4+
push:
5+
branches:
6+
- publish
7+
8+
jobs:
9+
trigger_publish:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Trigger Developer Event
14+
uses: peter-evans/repository-dispatch@master
15+
with:
16+
token: ${{ secrets.BUILD_ACCESS_TOKEN }}
17+
repository: neo4j-documentation/docs-refresh
18+
event-type: labs

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.DS_Store
2+
build
3+
node_modules/

‎README.adoc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
= Neo4j Labs Pages
2+
3+
image::https://github.com/neo4j-documentation/labs-pages/workflows/Trigger%20Publish/badge.svg[Trigger Publish]
4+
image::https://github.com/neo4j-documentation/docs-refresh/workflows/Publish%20Labs/badge.svg[Publish Labs]
5+
6+
Built with link:https://antora.org/[Antora^].
7+
8+
- link:https://docs.antora.org/antora/2.3/standard-directories/[Standard File and Directory Set^]
9+
- link:https://docs.antora.org/antora/2.3/module-directories/[Module Directories and Modules^]
10+
11+
== Installation
12+
13+
To build these docs locally you will need link:https://nodejs.org/en/download/package-manager/[Node & NPM^] installed.
14+
15+
To install the dependencies run:
16+
17+
[source,sh]
18+
npm install
19+
20+
21+
== Live Preview
22+
23+
To preview the docs, run:
24+
25+
[source,sh]
26+
npm run dev
27+
28+
29+
This will build a set of HTML files in `build/site` and then serve them through an express server at http://localhost:8000.
30+
The dev script will also listen for changes and automatically rebuild the files automatically.
31+
You'll still need to refresh the page to view the changes.
32+
33+
34+
== Publishing
35+
36+
Pushing to the `publish` branch of this repo will trigger a rebuild of the HTML and CSS files in the link:https://github.com/neo4j-documentation/docs-refresh[Docs Refresh^] repo using a Github Action.
37+
38+
39+
[source,sh]
40+
git clone https://github.com/neo4j-documentation/labs-pages
41+
git add .
42+
git commit -m "My changes"
43+
git push origin HEAD:publish
44+
45+
At the end of the build process, the files are uploaded to the `static-content.neo4j.com` S3 Bucket. From there, they are synced up to the Neo4j.com server once an hour, on the hour by a cronjob.
46+

‎antora.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: labs
2+
version: master
3+
title: Neo4j Labs
4+
start_page: ROOT:index.adoc
5+
nav:
6+
- modules/ROOT/nav.adoc
7+
- modules/apoc/nav.adoc
8+
- modules/etl-tool/nav.adoc
9+
- modules/grandstack-graphql/nav.adoc
10+
# - modules/graph-algorithms/nav.adoc
11+
- modules/halin/nav.adoc
12+
- modules/neo4j-helm/nav.adoc
13+
- modules/neosemantics/nav.adoc
14+
- modules/kafka/nav.adoc
15+
16+
asciidoc:
17+
attributes:
18+
page-theme: labs
19+
20+
community-name: Neo4j Community Site
21+
community-url: https://community.neo4j.com/
22+
neosemantics-category-name: Linked Data, RDF, Ontology
23+
neosemantics-category-url: https://community.neo4j.com/c/integrations/linked-data-rdf-ontology/162

‎modules/ROOT/nav.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* xref:index.adoc[Labs Home]
2+
* link:/developer/graph-algorithms[Graph Algorithms Library^]

‎modules/ROOT/pages/index.adoc

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
= Neo4j Labs
2+
:description: Incubating the next generation of graph developer tooling. GraphQL and GRANDstack, Algorithms, APOC, Kafka, ETL Tool, neovis.js, and more.
3+
:page-layout: labs
4+
:page-theme: labs
5+
:page-herotitle: Neo4j Labs
6+
:page-herosubtitle: Incubating the Next Generation of Graph Developer Tooling
7+
8+
[.secondary]
9+
== What is Neo4j Labs?
10+
Neo4j Labs is a collection of the latest innovations in graph technology.
11+
These projects are designed and developed by the Neo4j team as a way to test functionality and extensions of our link:https://neo4j.com/product/?ref=labs[product offerings].
12+
A project typically either graduates to being maintained as a formal Neo4j project or is deprecated with source made available publicly.
13+
14+
These Labs are supported via the link:https://community.neo4j.com/?_ga=2.65967848.79768660.1594637016-1548419832.1589810895[online community].
15+
They are actively developed and maintained, but we don't provide any SLAs or guarantees around backwards compatibility and deprecation.
16+
17+
18+
== Current Projects
19+
20+
=== link:https://neo4j.com/developer/graph-algorithms/[Graph Algorithms Library]
21+
22+
To enable large scale graph analytics and to support machine learning pipelines, we developed the link:https://neo4j.com/developer/graph-algorithms/[Neo4j Graph Algorithms^] library, which covers many widely used algorithms.
23+
The library offers highly parallelized implementation that works well with large scale graphs.
24+
25+
[#goals.incremental]
26+
=== xref:grandstack-graphql:index.adoc[GraphQL and GRANDstack]
27+
GraphQL has become a comprehensive stack for API development and consolidation.
28+
Our link:https://www.grandstack.io[GRANDstack^] and Neo4j-GraphQL-js offerings combine the most common tools and frameworks: GraphQL, React, Apollo and Neo4j Database.
29+
30+
31+
=== xref:apoc:index.adoc[Awesome Procedures on Cypher (APOC)]
32+
33+
As the most comprehensive developer toolkit for Neo4j, the xref:apoc:index.adoc[APOC library] provides a wide range of procedures and functions that make your life as a Neo4j user easier.
34+
APOC includes data integration, graph refactoring, data conversion, operational functionality and more.
35+
36+
=== xref:halin:index.adoc[Halin Monitoring App]
37+
38+
The link:https://neo4j.com/labs/halin[Halin Monitoring App] allows you to monitor your Neo4j deployment and identify bottlenecks or incorrect configurations, with insights into currently running queries and workloads.
39+
The app also provides access to metrics and logs.
40+
41+
42+
=== xref:kafka:index.adoc[Kafka Integration]
43+
44+
Streaming event data is an integral part of most modern data architectures.
45+
With xref:kafka:index.adoc[Neo4j Kafka Integration] you can integrate Neo4j both as a sink or source into your setup.
46+
The integration is available as a Kafka Connect plugin and Neo4j Server extension..
47+
48+
49+
=== xref:etl-tool:index.adoc[ETL Tool]
50+
51+
Having an easy way of loading data from relational databases into Neo4j is one of the first steps many users take.
52+
The xref:etl-tool:index.adoc[Neo4j-ETL Tool] makes this easy by inferring a graph model from the relational meta model that you can then adapt to fit your needs.
53+
Given that transformation, this tool also handles the actual import for you.
54+
55+
=== xref:neosemantics:index.adoc[Neosemantics]
56+
57+
xref:neosemantics:index.adoc[Neosemantics] integrates RDF and Linked Data with Neo4j.
58+
It allows to import a wide variety of RDF formats and to expose Neo4j property graphs as Linked Data.
59+
Ontology and Inference are also partially supported.
60+
61+
=== xref:neo4j-helm:index.adoc[Neo4j-Helm]
62+
63+
xref:neo4j-helm:index.adoc[Neo4j-Helm] is a tool for configuring and deploying Neo4j instances on Kubernetes. By using the Helm
64+
package manager for Kubernetes, it makes it simple to specify advanced configurations of Neo4j, both standalone and cluster, and
65+
run them with Kubernetes across many cloud platforms.
66+
67+
=== Other Active Projects
68+
69+
* link:https://github.com/neo4j-contrib/neovis.js/[Neovis.js^], a graph visualization toolkit for the web
70+
* link:https://github.com/neo4j-contrib/neo4j-spark-connector/[The Neo4j-Spark-Connector^], library to exchange graph data between Neo4j and Apache Spark
71+
72+
[.secondary]
73+
== Frequently Asked Questions
74+
75+
=== Are these safe to use in production?
76+
Current Neo4j Labs projects are being actively worked on by our engineers, and may be rough around the edges, with changing APIs, as they push the edge of the envelope. Therefore, we cannot provide official commercial support for these projects or guarantee longevity. However, some Neo4j customers and users still love the functionality of these projects and choose to continue using them in production environments.
77+
78+
=== How do I contribute?
79+
We welcome contributions for those labs which are open source projects. You'll find links to GitHub repositories - feel free to submit PRs. We've also created a discussion category for Labs on link:https://community.neo4j.com[community.neo4j.com^]
80+
81+
=== Which Neo4j Labs projects have graduated?
82+
The link:https://hub.docker.com/_/neo4j[Neo4j Docker containers] started off as a Labs project to explore how well Neo4j would run in a containerized environment. They quickly gained popularity and are heavily used by both Neo4j and customers, so we've graduated them to be officially part of the Neo4j release distribution.
83+
84+
We've also had features originally implemented as plugins and extensions moved into the core product. This includes link:https://neo4j.com/graphconnect-2018/session/neo4j-spatial-mapping[spatial functionality^] and APOC link:https://neo4j.com/docs/operations-manual/3.5/reference/procedures/[meta graph^] plus link:https://neo4j.com/docs/operations-manual/current/performance/index-configuration/fulltext/[full text indexing^].
85+
86+
=== Which Neo4j Labs projects have been deprecated?
87+
The MongoDB Doc Manager and Cassandra Connector have both been deprecated. The source is still available on GitHub, but we found most developers could accomplish similiar goals by using APOC, Kafka and other technologies.

0 commit comments

Comments
 (0)