diff --git a/.github/workflows/docs-deploy-surge.yml b/.github/workflows/docs-deploy-surge.yml index 2399928e4..af15f418b 100644 --- a/.github/workflows/docs-deploy-surge.yml +++ b/.github/workflows/docs-deploy-surge.yml @@ -17,7 +17,7 @@ on: - completed jobs: - publish-docs: + deploy-docs: # Uncomment this if statement to deploy only when the PR builds cleanly # if: github.event.workflow_run.conclusion == 'success' @@ -63,11 +63,6 @@ jobs: - id: unzip-docs run: unzip docs.zip - - id: get-top-dir - run: | - root=$(ls -d */index.html | sed -r 's/(.*)\/index\.html/\1/') - echo "top-dir=$root" >> $GITHUB_OUTPUT - - id: unzip-changelog if: ${{ hashFiles('changelog.zip') != '' }} run: unzip changelog.zip @@ -99,13 +94,13 @@ jobs: SITE_DIR: ${{ steps.get-top-dir.outputs.top-dir }} run: | npm install -g surge - surge ./$SITE_DIR $DEPLOY_URL --token "$SURGE_TOKEN" + surge . $DEPLOY_URL --token "$SURGE_TOKEN" # If the PR artifacts include a changelog file, add it to the PR as a comment # The changelog contains links to new and changed files in the deployed docs - name: Comment on PR (changelog) if: ${{ hashFiles('changelog') != '' }} - uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 #v2.9.0 + uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 #v2 with: number: ${{ steps.get-deploy-id.outputs.deploy-id }} recreate: true @@ -118,7 +113,7 @@ jobs: if: ${{ hashFiles('changelog') == '' }} env: DEPLOY_URL: ${{ steps.get-deploy-url.outputs.deploy-url }} - uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 #v2.9.0 + uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 #v2 with: number: ${{ steps.get-deploy-id.outputs.deploy-id }} header: docs-pr-changes @@ -126,4 +121,4 @@ jobs: Looks like you've updated the documentation! Check out your changes at https://${{ env.DEPLOY_URL }} - GITHUB_TOKEN: ${{ secrets.DOCS_PR_COMMENT_TOKEN }} + GITHUB_TOKEN: ${{ secrets.DOCS_PR_COMMENT_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/docs-pr-checks.yml b/.github/workflows/docs-pr-checks.yml index 143117699..7ca01d0d1 100644 --- a/.github/workflows/docs-pr-checks.yml +++ b/.github/workflows/docs-pr-checks.yml @@ -1,5 +1,5 @@ -name: "Verify Docs PR" +name: "Verify docs PR" on: pull_request: @@ -12,7 +12,7 @@ jobs: # Generate HTML docs-build-pr: - uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@v1.2.0 + uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@v2 with: deploy-id: ${{ github.event.number }} retain-artifacts: 14 @@ -22,7 +22,7 @@ jobs: # By default, the job fails if there are errors, passes if there are warnings only. docs-verify-pr: needs: docs-build-pr - uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@v1.2.0 + uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@v2 with: failOnWarnings: true @@ -44,9 +44,9 @@ jobs: separator: ',' files_yaml: | pages: - - modules/**/pages/**/*.adoc + - '**/modules/**/pages/**/*.adoc' asciidoc: - - modules/**/*.adoc + - '**/modules/**/*.adoc' # Generate a PR comment if the docs are using the pageList extension # The extension maps asciidoc source files to their HTML output paths @@ -54,7 +54,7 @@ jobs: docs-updates-comment-pr: if: needs.docs-build-pr.outputs.pages-listed == 'success' needs: [docs-build-pr, docs-changes-pr] - uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@v1.2.0 + uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@v2 with: pages-modified: ${{ needs.docs-changes-pr.outputs.pages-modified }} - pages-added: ${{ needs.docs-changes-pr.outputs.pages-added }} + pages-added: ${{ needs.docs-changes-pr.outputs.pages-added }} \ No newline at end of file diff --git a/.github/workflows/docs-teardown.yml b/.github/workflows/docs-teardown.yml index 936c829a3..cb2524d33 100644 --- a/.github/workflows/docs-teardown.yml +++ b/.github/workflows/docs-teardown.yml @@ -7,7 +7,6 @@ on: - "dev" - "cypher-25" - "cypher-5" - types: - closed @@ -16,7 +15,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/setup-node@v3 + - uses: actions/setup-node@v4 with: node-version: lts/* @@ -39,7 +38,7 @@ jobs: surge teardown $DEPLOY_URL --token "$SURGE_TOKEN" - name: Comment on PR - uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 # v2.9.0 + uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 #v2 with: number: ${{ github.event.pull_request.number }} header: docs-pr-changes @@ -48,4 +47,4 @@ jobs: The preview documentation has now been torn down - reopening this PR will republish it. GITHUB_TOKEN: ${{ secrets.DOCS_PR_COMMENT_TOKEN }} - + \ No newline at end of file diff --git a/modules/ROOT/pages/appendix/gql-conformance/additional-cypher.adoc b/modules/ROOT/pages/appendix/gql-conformance/additional-cypher.adoc index 638326deb..fa3c55bc4 100644 --- a/modules/ROOT/pages/appendix/gql-conformance/additional-cypher.adoc +++ b/modules/ROOT/pages/appendix/gql-conformance/additional-cypher.adoc @@ -55,7 +55,7 @@ Either the pattern already exists, or it needs to be created. | xref:values-and-types/spatial.adoc[`POINT` values] | Spatial values. -| xref:values-and-types/maps.adoc#query-operators-list[`MAP` values]. +| xref:values-and-types/maps.adoc[`MAP` values]. | Map values - the GQL equivalent is Records. |=== diff --git a/modules/ROOT/pages/expressions/list-expressions.adoc b/modules/ROOT/pages/expressions/list-expressions.adoc index d370a76ac..6adc98856 100644 --- a/modules/ROOT/pages/expressions/list-expressions.adoc +++ b/modules/ROOT/pages/expressions/list-expressions.adoc @@ -358,7 +358,7 @@ RETURN [1, 2] || [3, null] AS listWithNull 1+d|Rows: 1 |=== -For removing `null` values when concatenating `LIST` values, see xref:expressions/list-expressions.adoc#null-list-concatenation-list-comprehension[`null`, list concatenation, and list comprehension]. +For removing `null` values when concatenating `LIST` values, see xref:expressions/list-expressions.adoc#list-comprehension[List comprehension]. [[add-elements]] == Add elements to a list diff --git a/modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc b/modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc index 6312ac73d..d9fbc217c 100644 --- a/modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc +++ b/modules/ROOT/pages/indexes/search-performance-indexes/using-indexes.adoc @@ -264,12 +264,12 @@ WITH {name: 'William Shakespeare'} AS varName MERGE (:PointOfInterest {name: toString(varName.name)}) ---- -For information about how to ensure the use of text indexes when predicates may contain `null` values, see xref:indexes/search-performance-indexes/using-indexes/indexes-and-null[Indexes and `null` values]. +For information about how to ensure the use of text indexes when predicates may contain `null` values, see xref:indexes/search-performance-indexes/using-indexes.adoc#indexes-and-null[Indexes and `null` values]. [[text-index-string-size]] === Text indexes and `STRING` sizes -The size of the indexed `STRING` properties is also relevant to the planner’s selection between range and text indexes. +The size of the indexed `STRING` properties is also relevant to the planner's selection between range and text indexes. Range indexes have a maximum key size limit of around 8 kb. This means that range indexes cannot be used to index `STRING` values larger than 8 kb. diff --git a/modules/ROOT/pages/values-and-types/vector.adoc b/modules/ROOT/pages/values-and-types/vector.adoc index 6253b9a06..d61b58db8 100644 --- a/modules/ROOT/pages/values-and-types/vector.adoc +++ b/modules/ROOT/pages/values-and-types/vector.adoc @@ -103,7 +103,7 @@ For example, `VECTOR(4)` is a supertype of `VECTOR(4)` and `VECTOR( - `VECTOR` with only a defined coordinate type is a supertype of all `VECTOR` values with that coordinate type, regardless of the dimension. For example, `VECTOR` is a supertype of `VECTOR(3)` and `VECTOR(1024)`. -All of these supertypes can be used in xref:expressions/predicates/type-predicate-expressions.adoc#type-predicate-vector[type predicate expressions]. +All of these supertypes can be used in xref:expressions/predicates/type-predicate-expressions.adoc[type predicate expressions]. For more information, see: * xref:values-and-types/ordering-equality-comparison.adoc#ordering-and-comparison[Equality, ordering, and comparison of value types -> Ordering vector types] diff --git a/modules/ROOT/pages/values-and-types/working-with-null.adoc b/modules/ROOT/pages/values-and-types/working-with-null.adoc index 5d732bd46..653be8e5f 100644 --- a/modules/ROOT/pages/values-and-types/working-with-null.adoc +++ b/modules/ROOT/pages/values-and-types/working-with-null.adoc @@ -41,7 +41,7 @@ The xref::expressions/predicates/boolean-operators.adoc[boolean operators] (`AND [[cypher-null-in-operator]] == The `IN` operator and `null` -The xref:expressions/predicates/list-operators[`IN` operator] follows similar logic. +The xref:expressions/predicates/list-operators.adoc[`IN` operator] follows similar logic. If Cypher can ascertain that something exists in a list, the result will be `true`. Any list that contains a `null` and does not have a matching element will return `null`. Otherwise, the result will be `false`. diff --git a/package.json b/package.json index 47024d36b..31237e8da 100644 --- a/package.json +++ b/package.json @@ -5,12 +5,16 @@ "main": "server.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "start": "nodemon -e adoc --exec \"npm run build && npm run serve\"", + "prestart": "npm update", + "start": "nodemon -e adoc --exec \"npm run build\"", "serve": "node server.js", - "adoc-gen": "node scripts/adoc-gen.js", - "build": "antora preview.yml --stacktrace --log-format=pretty", - "build-verify": "antora --stacktrace --fetch preview.yml --log-format=json --log-level=info --log-file ./build/log/log.json", - "publish-verify": "antora --stacktrace --fetch publish.yml --log-format=json --log-file ./build/log/log.json" + "clean": "rm -rf build", + "build": "npm run build:preview", + "postbuild": "node server.js", + "build:preview": "antora preview.yml --stacktrace --log-format=pretty", + "build:publish": "npm run clean && antora publish.yml --stacktrace --log-format=pretty", + "verify:preview": "antora --stacktrace --fetch preview.yml --log-format=json --log-level=info --log-file ./build/log/log.json", + "verify:publish": "antora --stacktrace --fetch publish.yml --log-format=json --log-level=info --log-file ./build/log/log.json" }, "keywords": [ "antora", @@ -19,8 +23,6 @@ "author": "Neo4j", "license": "ISC", "dependencies": { - "@antora/cli": "^3.1.10", - "@antora/site-generator-default": "^3.1.10", "@neo4j-antora/antora-add-notes": "^0.3.2", "@neo4j-antora/antora-modify-sitemaps": "^0.7.1", "@neo4j-antora/antora-page-roles": "^0.3.1", @@ -28,6 +30,7 @@ "@neo4j-antora/mark-terms": "1.1.0", "@neo4j-documentation/macros": "^1.0.4", "@neo4j-documentation/remote-include": "^1.0.0", + "antora": "3.1.14", "asciidoctor-kroki": "^0.18.1" }, "devDependencies": { diff --git a/preview.yml b/preview.yml index b70cd4e8a..0125ae200 100644 --- a/preview.yml +++ b/preview.yml @@ -22,13 +22,16 @@ ui: urls: html_extension_style: indexify +antora: + extensions: + - "@neo4j-antora/table-footnotes" + asciidoc: extensions: - "@neo4j-documentation/remote-include" - "@neo4j-documentation/macros" - "@neo4j-antora/antora-add-notes" - "@neo4j-antora/antora-page-roles" - - "@neo4j-antora/antora-table-footnotes" - "@neo4j-antora/mark-terms" - asciidoctor-kroki attributes: diff --git a/publish.yml b/publish.yml index 5fcba79e9..16a8ab8bc 100644 --- a/publish.yml +++ b/publish.yml @@ -22,13 +22,16 @@ ui: urls: html_extension_style: indexify +antora: + extensions: + - "@neo4j-antora/table-footnotes" + asciidoc: extensions: - "@neo4j-documentation/remote-include" - "@neo4j-documentation/macros" - "@neo4j-antora/antora-add-notes" - "@neo4j-antora/antora-page-roles" - - "@neo4j-antora/antora-table-footnotes" - "@neo4j-antora/mark-terms" - asciidoctor-kroki attributes: