Neo4j Getting Started Guide

This repository contains the AsciiDoc and other sources to build the Neo4j Getting Started Guide.

Installation

To build these docs locally you will need Node & NPM installed.

To install the dependencies run:

npm install

Live Preview

To preview the docs, run:

npm run start

This will build a set of HTML files in build/site and then serve them through an express server at http://localhost:8000. The start script will also listen for changes and automatically rebuild the files automatically. You’ll still need to refresh the page to view the changes.

Contributing

To make changes to this repository, please create a fork of this repo and a new branch to stage your changes.

Branch management

The docs-getting-started repo contains the following branches:

• dev - this branch is published on the staging server, as a preview, but we will never publish from this branch publicly.

• main - this is the currently published version, and therefore is the branch that we publish the GSG from. PRs merged into this branch will be published live immediately.

• Other (versioned) branches — 3.5, 4.0, 4.4, 5.x, etc. — are not maintained any longer.

Raising Pull Requests

Since the Getting Started Guide has no version, raise your Pull Request against the dev branch.

If your changes have to be published immediately, create a PR against the main branch.

The general recommendation is to raise PRs against the dev branch and cherry-pick them back to main branch.

Please, add at least one approver.