From ba3ee96bc362ea2452d00d370c2d9dd4b3853e1b Mon Sep 17 00:00:00 2001 From: Neil Dewhurst Date: Mon, 21 Aug 2023 10:40:09 +0100 Subject: [PATCH] Add core vs extended warning (#3719) * Add notes package * Add warning to all pages * Remove existing warnings * Update docs/asciidoc/modules/notes/partials/notes.adoc Use emphasis (bold) for APOC Core and APOC Extended Co-authored-by: David Oliver --- docs/antora/package-lock.json | 11 +++++++++++ docs/antora/package.json | 1 + docs/antora/preview.yml | 7 +++++-- .../ROOT/pages/deprecations-and-additions/index.adoc | 6 ------ docs/asciidoc/modules/ROOT/pages/index.adoc | 5 ----- docs/asciidoc/modules/ROOT/pages/overview/index.adoc | 7 ------- docs/asciidoc/modules/notes/partials/notes.adoc | 9 +++++++++ 7 files changed, 26 insertions(+), 20 deletions(-) create mode 100644 docs/asciidoc/modules/notes/partials/notes.adoc diff --git a/docs/antora/package-lock.json b/docs/antora/package-lock.json index 0d1cd17d1e..cd609c4451 100644 --- a/docs/antora/package-lock.json +++ b/docs/antora/package-lock.json @@ -11,6 +11,7 @@ "dependencies": { "@antora/cli": "^3.1.1", "@antora/site-generator-default": "^3.1.1", + "@neo4j-antora/antora-add-notes": "^0.3.0", "@neo4j-documentation/macros": "^1.0.0", "@neo4j-documentation/remote-include": "^1.0.0", "express": "^4.17.1", @@ -292,6 +293,11 @@ "resolved": "https://registry.npmjs.org/@iarna/toml/-/toml-2.2.5.tgz", "integrity": "sha512-trnsAYxU3xnS1gPHPyU961coFyLkh4gAD/0zQ5mymY4yOZ+CYvsPqUbOFSw0aDM4y0tV7tiFxL/1XfXPNC6IPg==" }, + "node_modules/@neo4j-antora/antora-add-notes": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/@neo4j-antora/antora-add-notes/-/antora-add-notes-0.3.0.tgz", + "integrity": "sha512-aHPErkKLZxe8yOtUuthLVf1mC0Pta3JZhGoX4SN6HRnroNBTaa5i3/JSSorFrB3F+XuVJXZDxnRUCubFvGLkUg==" + }, "node_modules/@neo4j-documentation/macros": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/@neo4j-documentation/macros/-/macros-1.0.2.tgz", @@ -3083,6 +3089,11 @@ "resolved": "https://registry.npmjs.org/@iarna/toml/-/toml-2.2.5.tgz", "integrity": "sha512-trnsAYxU3xnS1gPHPyU961coFyLkh4gAD/0zQ5mymY4yOZ+CYvsPqUbOFSw0aDM4y0tV7tiFxL/1XfXPNC6IPg==" }, + "@neo4j-antora/antora-add-notes": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/@neo4j-antora/antora-add-notes/-/antora-add-notes-0.3.0.tgz", + "integrity": "sha512-aHPErkKLZxe8yOtUuthLVf1mC0Pta3JZhGoX4SN6HRnroNBTaa5i3/JSSorFrB3F+XuVJXZDxnRUCubFvGLkUg==" + }, "@neo4j-documentation/macros": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/@neo4j-documentation/macros/-/macros-1.0.2.tgz", diff --git a/docs/antora/package.json b/docs/antora/package.json index 86c9772927..76da6dcdff 100644 --- a/docs/antora/package.json +++ b/docs/antora/package.json @@ -14,6 +14,7 @@ "dependencies": { "@antora/cli": "^3.1.1", "@antora/site-generator-default": "^3.1.1", + "@neo4j-antora/antora-add-notes": "^0.3.0", "@neo4j-documentation/macros": "^1.0.0", "@neo4j-documentation/remote-include": "^1.0.0", "express": "^4.17.1", diff --git a/docs/antora/preview.yml b/docs/antora/preview.yml index f7c3d135a5..a0bc40a62e 100644 --- a/docs/antora/preview.yml +++ b/docs/antora/preview.yml @@ -13,15 +13,18 @@ content: - '!**/README.adoc' ui: bundle: - url: https://s3-eu-west-1.amazonaws.com/static-content.neo4j.com/build/ui-bundle.zip + url: https://static-content.neo4j.com/build/ui-bundle.zip snapshot: true urls: html_extension_style: indexify asciidoc: extensions: + - "@neo4j-antora/antora-add-notes" - "@neo4j-documentation/remote-include" - "@neo4j-documentation/macros" attributes: page-theme: labs - page-disabletracking: true \ No newline at end of file + page-disabletracking: true + page-add-notes-module: notes@ + page-add-notes-tags: core-warning@ \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/pages/deprecations-and-additions/index.adoc b/docs/asciidoc/modules/ROOT/pages/deprecations-and-additions/index.adoc index d4b2922241..a60433ef26 100644 --- a/docs/asciidoc/modules/ROOT/pages/deprecations-and-additions/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/deprecations-and-additions/index.adoc @@ -2,12 +2,6 @@ = Deprecations and additions :description: This chapter lists all the features that have been removed, deprecated, added or extended in the recent versions of APOC. -[WARNING] -==== -This is the page for APOC Extended documentation. -For the officially supported APOC Core, go to the https://neo4j.com/docs/apoc/{branch}/deprecations-and-additions/[APOC Core page]. -==== - This chapter lists all the features that have been removed, deprecated, added or extended in the recent versions of APOC. [[apoc-deprecations-additions-removals-5.0]] diff --git a/docs/asciidoc/modules/ROOT/pages/index.adoc b/docs/asciidoc/modules/ROOT/pages/index.adoc index 4bc8e462be..55f02d004c 100644 --- a/docs/asciidoc/modules/ROOT/pages/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/index.adoc @@ -10,11 +10,6 @@ :gh-docs: https://neo4j-contrib.github.io/neo4j-apoc-procedures :description: This is the APOC Extended user guide, authored by the Neo4j Labs Team. -[WARNING] -==== -This is the page for APOC Extended documentation. -For the officially supported APOC Core, go to the https://neo4j.com/docs/apoc/{branch}/[APOC Core page]. -==== The guide covers the following areas: diff --git a/docs/asciidoc/modules/ROOT/pages/overview/index.adoc b/docs/asciidoc/modules/ROOT/pages/overview/index.adoc index 94bda792b4..d53ca3f8a6 100644 --- a/docs/asciidoc/modules/ROOT/pages/overview/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/overview/index.adoc @@ -2,11 +2,4 @@ = Procedures & Functions :description: This chapter provides a reference of all the procedures and functions in the APOC Extended library. - -[WARNING] -==== -This is the page for APOC Extended documentation. -For the officially supported APOC Core, go to the https://neo4j.com/docs/apoc/{branch}/overview/[APOC Core page]. -==== - include::partial$generated-documentation/documentation.adoc[] \ No newline at end of file diff --git a/docs/asciidoc/modules/notes/partials/notes.adoc b/docs/asciidoc/modules/notes/partials/notes.adoc new file mode 100644 index 0000000000..0ebb53b028 --- /dev/null +++ b/docs/asciidoc/modules/notes/partials/notes.adoc @@ -0,0 +1,9 @@ +# tag::core-warning[] +[WARNING] +==== +This is the *APOC Extended* documentation. + +APOC Extended is not supported by Neo4j. +For the officially supported *APOC Core*, go to the link:https://neo4j.com/docs/apoc/[APOC Core page]. +==== +# end::core-warning[] \ No newline at end of file