Skip to content

Commit 8532ff7

Browse files
authored
4.3 migration (#207)
Initial content migrated from https://github.com/neo4j/neo4j-documentation/
1 parent f791315 commit 8532ff7

File tree

146 files changed

+23982
-27967
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+23982
-27967
lines changed
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Use this starter workflow to deploy HTML generated by Antora to surge.sh
2+
# Docs are published at <org>-<repo>-<deployid>.surge.sh
3+
# By default, this workflow runs on completion of a workflow called "Verify PR"
4+
# This workflow expects the triggering workflow to generate an artifact called "docs"
5+
6+
# - update the reference to "docs" and "docs.zip" in this workflow if your triggering workflow generates an artifact with a different name
7+
name: "Deploy to surge"
8+
9+
on:
10+
workflow_run:
11+
workflows: ["Verify PR"]
12+
types:
13+
- completed
14+
15+
jobs:
16+
publish-docs:
17+
if: github.event.workflow_run.conclusion == 'success'
18+
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- name: "Download built documentation"
23+
uses: actions/[email protected]
24+
with:
25+
script: |
26+
var artifacts = await github.rest.actions.listWorkflowRunArtifacts({
27+
owner: context.repo.owner,
28+
repo: context.repo.repo,
29+
run_id: ${{ github.event.workflow_run.id }},
30+
});
31+
var matchArtifact = artifacts.data.artifacts.filter((artifact) => {
32+
return artifact.name == "docs"
33+
})[0];
34+
var download = await github.rest.actions.downloadArtifact({
35+
owner: context.repo.owner,
36+
repo: context.repo.repo,
37+
artifact_id: matchArtifact.id,
38+
archive_format: 'zip',
39+
});
40+
var fs = require('fs');
41+
fs.writeFileSync('${{ github.workspace }}/docs.zip', Buffer.from(download.data));
42+
43+
- run: unzip docs.zip
44+
45+
- id: get-deploy-id
46+
run: |
47+
deployid=$(<deployid)
48+
echo "::set-output name=deploy-id::$deployid"
49+
50+
- uses: actions/setup-node@v3
51+
with:
52+
node-version: lts/*
53+
54+
- name: Deploy docs to surge
55+
run: |
56+
npm install -g surge
57+
surge ./site ${{ github.event.repository.owner.login}}-${{ github.event.repository.name}}-${{ steps.get-deploy-id.outputs.deploy-id }}.surge.sh --token ${{ secrets.SURGE_TOKEN }}
58+
59+
- name: Comment on PR
60+
uses: marocchino/sticky-pull-request-comment@v2
61+
with:
62+
number: ${{ steps.get-deploy-id.outputs.deploy-id }}
63+
message: |
64+
Looks like you've updated the documentation!
65+
66+
Check out your changes at https://${{ github.event.repository.owner.login}}-${{ github.event.repository.name}}-${{ steps.get-deploy-id.outputs.deploy-id }}.surge.sh
67+
GITHUB_TOKEN: ${{ secrets.PR_COMMENT_TOKEN }}

.github/workflows/docs-pr.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Use this starter workflow to verify PRs that include a change to the docs
2+
# The default setup runs against PRs targeting your default branch
3+
# Default artifact retention is 7 days
4+
5+
name: "Verify PR"
6+
7+
on:
8+
pull_request:
9+
branches:
10+
- "3.5"
11+
- "4.[0-9]"
12+
- "5.0"
13+
- "5.x"
14+
- "dev"
15+
- "feature-*"
16+
17+
jobs:
18+
19+
# note that the build job requires a build-verify script in package.json
20+
# build-verify should build html with Antora, and output a .json log file
21+
# eg 'antora playbook.yml --log-format=json --log-file ./build/log/log.json'
22+
docs-build-for-pr:
23+
uses: recrwplay/actions-demo/.github/workflows/reusable-docs-build.yml@main
24+
with:
25+
deploy-id: ${{ github.event.number }}
26+
retain-artifacts: 14
27+
28+
docs-verify-for-pr:
29+
needs: docs-build-for-pr
30+
uses: recrwplay/actions-demo/.github/workflows/reusable-docs-verify.yml@main
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# copy this workflow into your repo
2+
name: "Documentation Teardown"
3+
4+
on:
5+
pull_request_target:
6+
branches:
7+
- "3.5"
8+
- "4.[0-9]"
9+
- "5.0"
10+
- "5.x"
11+
- "dev"
12+
- "feature-*"
13+
types:
14+
- closed
15+
16+
jobs:
17+
teardown-docs:
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- uses: actions/setup-node@v3
22+
with:
23+
node-version: lts/*
24+
- name: Teardown documentation
25+
run: |
26+
npm install -g surge
27+
surge teardown ${{ github.event.repository.owner.login}}-${{ github.event.repository.name}}-${{ github.event.pull_request.number }}.surge.sh --token ${{ secrets.SURGE_TOKEN }}
28+

antora.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
name: cypher-manual
22
title: Cypher Manual
3-
version: '4.4'
3+
version: '4.3'
44
start_page: ROOT:index.adoc
55
nav:
66
- modules/ROOT/content-nav.adoc
77
asciidoc:
88
attributes:
9-
neo4j-version: '4.4'
10-
neo4j-version-exact: '4.4.9'
9+
neo4j-version: '4.3'
10+
neo4j-version-exact: '4.3.21'

modules/ROOT/content-nav.adoc

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
* xref:index.adoc[]
22
33
* xref:introduction/index.adoc[]
4+
// ** xref:introduction/cypher-introduction.adoc[]
45
** xref:introduction/neo4j-databases-graphs.adoc[]
56
** xref:introduction/quering-updating-administering.adoc[]
67
** xref:introduction/transactions.adoc[]
@@ -45,8 +46,6 @@
4546
** xref:clauses/load-csv.adoc[]
4647
** xref:clauses/listing-functions.adoc[]
4748
** xref:clauses/listing-procedures.adoc[]
48-
** xref:clauses/transaction-clauses.adoc#query-listing-transactions[SHOW TRANSACTIONS]
49-
** xref:clauses/transaction-clauses.adoc#query-terminate-transactions[TERMINATE TRANSACTIONS]
5049
5150
* xref:functions/index.adoc[]
5251
** xref:functions/predicate.adoc[]
@@ -58,20 +57,41 @@
5857
** xref:functions/mathematical-trigonometric.adoc[]
5958
** xref:functions/string.adoc[]
6059
** xref:functions/temporal/index.adoc[]
60+
*** xref:functions/temporal/index.adoc#functions-date[date()]
61+
*** xref:functions/temporal/index.adoc#functions-datetime[datetime()]
62+
*** xref:functions/temporal/index.adoc#functions-localdatetime[localdatetime()]
63+
*** xref:functions/temporal/index.adoc#functions-localtime[localtime()]
64+
*** xref:functions/temporal/index.adoc#functions-time[time()]
6165
** xref:functions/temporal/duration.adoc[]
6266
** xref:functions/spatial.adoc[]
6367
** xref:functions/load-csv.adoc[]
6468
** xref:functions/user-defined.adoc[]
6569
6670
* xref:indexes-for-search-performance.adoc[]
71+
** xref:indexes-for-search-performance.adoc#administration-indexes-types[Indexes (types and limitations)]
72+
** xref:indexes-for-search-performance.adoc#administration-indexes-examples[Creating indexes]
73+
** xref:indexes-for-search-performance.adoc#administration-indexes-list-indexes[Listing indexes]
74+
** xref:indexes-for-search-performance.adoc#administration-indexes-drop-indexes[Deleting indexes]
75+
** xref:indexes-for-search-performance.adoc#administration-indexes-examples-deprecated-syntax[Deprecated syntax]
76+
77+
6778
* xref:indexes-for-full-text-search.adoc[]
79+
** xref:indexes-for-full-text-search.adoc#administration-indexes-fulltext-search-manage[Full-text search procedures]
80+
** xref:indexes-for-full-text-search.adoc#administration-indexes-fulltext-search-create-and-configure[Create and configure full-text indexes]
81+
** xref:indexes-for-full-text-search.adoc#administration-indexes-fulltext-search-query[Query full-text indexes]
82+
** xref:indexes-for-full-text-search.adoc#administration-indexes-fulltext-search-drop[Drop full-text indexes]
6883
6984
* xref:constraints/index.adoc[]
7085
** xref:constraints/syntax.adoc[]
7186
** xref:constraints/examples.adoc[]
7287
7388
* xref:databases.adoc[]
74-
* xref:aliases.adoc[]
89+
** xref:databases.adoc#administration-databases-show-databases[Listing databases]
90+
** xref:databases.adoc#administration-databases-create-database[Creating databases]
91+
** xref:databases.adoc#administration-databases-stop-database[Stopping databases]
92+
** xref:databases.adoc#administration-databases-start-database[Starting databases]
93+
** xref:databases.adoc#administration-databases-drop-database[Deleting databases]
94+
** xref:databases.adoc#administration-wait-nowait[Wait options]
7595
7696
* xref:access-control/index.adoc[]
7797
** xref:access-control/manage-users.adoc[]
@@ -85,22 +105,22 @@
85105
** xref:access-control/limitations.adoc[]
86106
87107
* xref:query-tuning/index.adoc[]
88-
** xref:query-tuning/query-options.adoc[]
89-
** xref:query-tuning/query-profile.adoc[]
108+
** xref:query-tuning/query-options.adoc#cypher-query-options[Query options]
109+
** xref:query-tuning/how-do-i-profile-a-query.adoc#how-do-i-profile-a-query[Profiling a query]
90110
** xref:query-tuning/indexes.adoc[]
91111
** xref:query-tuning/basic-example.adoc[]
92112
** xref:query-tuning/advanced-example.adoc[]
93113
** xref:query-tuning/using.adoc[]
94114
95115
* xref:execution-plans/index.adoc[]
96-
** xref:execution-plans/db-hits.adoc[]
97-
** xref:execution-plans/operator-summary.adoc[]
116+
** xref:execution-plans/operator-summary.adoc[Execution plan operators]
117+
** xref:execution-plans/db-hits.adoc[Database hits]
98118
** xref:execution-plans/operators.adoc[]
99119
** xref:execution-plans/shortestpath-planning.adoc[]
100120
101121
* xref:deprecations-additions-removals-compatibility.adoc[]
122+
102123
* xref:keyword-glossary.adoc[]
103124
104125
.Appendix
105126
* xref:styleguide.adoc[]
106-
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
1;ABBA;1992
2+
2;Roxette;1986
3+
3;Europe;1979
4+
4;The Cardigans;1992
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"1","The ""Symbol""","1992"
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Id,Name,Year
2+
1,ABBA,1992
3+
2,Roxette,1986
4+
3,Europe,1979
5+
4,The Cardigans,1992
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
1,ABBA,1992
2+
2,Roxette,1986
3+
3,Europe,1979
4+
4,The Cardigans,1992

0 commit comments

Comments
 (0)