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
67 changes: 67 additions & 0 deletions .github/workflows/docs-deploy-surge.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Use this starter workflow to deploy HTML generated by Antora to surge.sh
# Docs are published at <org>-<repo>-<deployid>.surge.sh
# By default, this workflow runs on completion of a workflow called "Verify PR"
# This workflow expects the triggering workflow to generate an artifact called "docs"

# - update the reference to "docs" and "docs.zip" in this workflow if your triggering workflow generates an artifact with a different name
name: "Deploy to surge"

on:
workflow_run:
workflows: ["Verify PR"]
types:
- completed

jobs:
publish-docs:
if: github.event.workflow_run.conclusion == 'success'

runs-on: ubuntu-latest

steps:
- name: "Download built documentation"
uses: actions/github-script@v6.0.0
with:
script: |
var artifacts = await github.rest.actions.listWorkflowRunArtifacts({
owner: context.repo.owner,
repo: context.repo.repo,
run_id: ${{ github.event.workflow_run.id }},
});
var matchArtifact = artifacts.data.artifacts.filter((artifact) => {
return artifact.name == "docs"
})[0];
var download = await github.rest.actions.downloadArtifact({
owner: context.repo.owner,
repo: context.repo.repo,
artifact_id: matchArtifact.id,
archive_format: 'zip',
});
var fs = require('fs');
fs.writeFileSync('${{ github.workspace }}/docs.zip', Buffer.from(download.data));

- run: unzip docs.zip

- id: get-deploy-id
run: |
deployid=$(<deployid)
echo "::set-output name=deploy-id::$deployid"

- uses: actions/setup-node@v3
with:
node-version: lts/*

- name: Deploy docs to surge
run: |
npm install -g surge
surge ./site ${{ github.event.repository.owner.login}}-${{ github.event.repository.name}}-${{ steps.get-deploy-id.outputs.deploy-id }}.surge.sh --token ${{ secrets.SURGE_TOKEN }}

- name: Comment on PR
uses: marocchino/sticky-pull-request-comment@v2
with:
number: ${{ steps.get-deploy-id.outputs.deploy-id }}
message: |
Looks like you've updated the documentation!

Check out your changes at https://${{ github.event.repository.owner.login}}-${{ github.event.repository.name}}-${{ steps.get-deploy-id.outputs.deploy-id }}.surge.sh
GITHUB_TOKEN: ${{ secrets.PR_COMMENT_TOKEN }}
30 changes: 30 additions & 0 deletions .github/workflows/docs-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Use this starter workflow to verify PRs that include a change to the docs
# The default setup runs against PRs targeting your default branch
# Default artifact retention is 7 days

name: "Verify PR"

on:
pull_request:
branches:
- "3.5"
- "4.[0-9]"
- "5.0"
- "5.x"
- "dev"
- "feature-*"

jobs:

# note that the build job requires a build-verify script in package.json
# build-verify should build html with Antora, and output a .json log file
# eg 'antora playbook.yml --log-format=json --log-file ./build/log/log.json'
docs-build-for-pr:
uses: recrwplay/actions-demo/.github/workflows/reusable-docs-build.yml@main
with:
deploy-id: ${{ github.event.number }}
retain-artifacts: 14

docs-verify-for-pr:
needs: docs-build-for-pr
uses: recrwplay/actions-demo/.github/workflows/reusable-docs-verify.yml@main
28 changes: 28 additions & 0 deletions .github/workflows/docs-teardown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# copy this workflow into your repo
name: "Documentation Teardown"

on:
pull_request_target:
branches:
- "3.5"
- "4.[0-9]"
- "5.0"
- "5.x"
- "dev"
- "feature-*"
types:
- closed

jobs:
teardown-docs:
runs-on: ubuntu-latest

steps:
- uses: actions/setup-node@v3
with:
node-version: lts/*
- name: Teardown documentation
run: |
npm install -g surge
surge teardown ${{ github.event.repository.owner.login}}-${{ github.event.repository.name}}-${{ github.event.pull_request.number }}.surge.sh --token ${{ secrets.SURGE_TOKEN }}

6 changes: 3 additions & 3 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: cypher-manual
title: Cypher Manual
version: '4.4'
version: '4.3'
start_page: ROOT:index.adoc
nav:
- modules/ROOT/content-nav.adoc
asciidoc:
attributes:
neo4j-version: '4.4'
neo4j-version-exact: '4.4.9'
neo4j-version: '4.3'
neo4j-version-exact: '4.3.21'
36 changes: 28 additions & 8 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
* xref:index.adoc[]

* xref:introduction/index.adoc[]
// ** xref:introduction/cypher-introduction.adoc[]
** xref:introduction/neo4j-databases-graphs.adoc[]
** xref:introduction/quering-updating-administering.adoc[]
** xref:introduction/transactions.adoc[]
Expand Down Expand Up @@ -45,8 +46,6 @@
** xref:clauses/load-csv.adoc[]
** xref:clauses/listing-functions.adoc[]
** xref:clauses/listing-procedures.adoc[]
** xref:clauses/transaction-clauses.adoc#query-listing-transactions[SHOW TRANSACTIONS]
** xref:clauses/transaction-clauses.adoc#query-terminate-transactions[TERMINATE TRANSACTIONS]

* xref:functions/index.adoc[]
** xref:functions/predicate.adoc[]
Expand All @@ -58,20 +57,41 @@
** xref:functions/mathematical-trigonometric.adoc[]
** xref:functions/string.adoc[]
** xref:functions/temporal/index.adoc[]
*** xref:functions/temporal/index.adoc#functions-date[date()]
*** xref:functions/temporal/index.adoc#functions-datetime[datetime()]
*** xref:functions/temporal/index.adoc#functions-localdatetime[localdatetime()]
*** xref:functions/temporal/index.adoc#functions-localtime[localtime()]
*** xref:functions/temporal/index.adoc#functions-time[time()]
** xref:functions/temporal/duration.adoc[]
** xref:functions/spatial.adoc[]
** xref:functions/load-csv.adoc[]
** xref:functions/user-defined.adoc[]

* xref:indexes-for-search-performance.adoc[]
** xref:indexes-for-search-performance.adoc#administration-indexes-types[Indexes (types and limitations)]
** xref:indexes-for-search-performance.adoc#administration-indexes-examples[Creating indexes]
** xref:indexes-for-search-performance.adoc#administration-indexes-list-indexes[Listing indexes]
** xref:indexes-for-search-performance.adoc#administration-indexes-drop-indexes[Deleting indexes]
** xref:indexes-for-search-performance.adoc#administration-indexes-examples-deprecated-syntax[Deprecated syntax]


* xref:indexes-for-full-text-search.adoc[]
** xref:indexes-for-full-text-search.adoc#administration-indexes-fulltext-search-manage[Full-text search procedures]
** xref:indexes-for-full-text-search.adoc#administration-indexes-fulltext-search-create-and-configure[Create and configure full-text indexes]
** xref:indexes-for-full-text-search.adoc#administration-indexes-fulltext-search-query[Query full-text indexes]
** xref:indexes-for-full-text-search.adoc#administration-indexes-fulltext-search-drop[Drop full-text indexes]

* xref:constraints/index.adoc[]
** xref:constraints/syntax.adoc[]
** xref:constraints/examples.adoc[]

* xref:databases.adoc[]
* xref:aliases.adoc[]
** xref:databases.adoc#administration-databases-show-databases[Listing databases]
** xref:databases.adoc#administration-databases-create-database[Creating databases]
** xref:databases.adoc#administration-databases-stop-database[Stopping databases]
** xref:databases.adoc#administration-databases-start-database[Starting databases]
** xref:databases.adoc#administration-databases-drop-database[Deleting databases]
** xref:databases.adoc#administration-wait-nowait[Wait options]

* xref:access-control/index.adoc[]
** xref:access-control/manage-users.adoc[]
Expand All @@ -85,22 +105,22 @@
** xref:access-control/limitations.adoc[]

* xref:query-tuning/index.adoc[]
** xref:query-tuning/query-options.adoc[]
** xref:query-tuning/query-profile.adoc[]
** xref:query-tuning/query-options.adoc#cypher-query-options[Query options]
** xref:query-tuning/how-do-i-profile-a-query.adoc#how-do-i-profile-a-query[Profiling a query]
** xref:query-tuning/indexes.adoc[]
** xref:query-tuning/basic-example.adoc[]
** xref:query-tuning/advanced-example.adoc[]
** xref:query-tuning/using.adoc[]

* xref:execution-plans/index.adoc[]
** xref:execution-plans/db-hits.adoc[]
** xref:execution-plans/operator-summary.adoc[]
** xref:execution-plans/operator-summary.adoc[Execution plan operators]
** xref:execution-plans/db-hits.adoc[Database hits]
** xref:execution-plans/operators.adoc[]
** xref:execution-plans/shortestpath-planning.adoc[]

* xref:deprecations-additions-removals-compatibility.adoc[]

* xref:keyword-glossary.adoc[]

.Appendix
* xref:styleguide.adoc[]

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
1;ABBA;1992
2;Roxette;1986
3;Europe;1979
4;The Cardigans;1992
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"1","The ""Symbol""","1992"
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Id,Name,Year
1,ABBA,1992
2,Roxette,1986
3,Europe,1979
4,The Cardigans,1992
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
1,ABBA,1992
2,Roxette,1986
3,Europe,1979
4,The Cardigans,1992
Binary file added modules/ROOT/images/grant-privileges-dbms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
81 changes: 0 additions & 81 deletions modules/ROOT/images/graph1.svg

This file was deleted.

51 changes: 0 additions & 51 deletions modules/ROOT/images/graph2.svg

This file was deleted.

Loading