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 <[email protected]>
neo4j-contrib · Aug 23, 2023 · ba3ee96 · ba3ee96
1 parent b3fae2d
commit ba3ee96
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 20 deletions.
diff --git a/docs/antora/package-lock.json b/docs/antora/package-lock.json
diff --git 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
@@ -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
+    page-disabletracking: true
+    page-add-notes-module: notes@
+    page-add-notes-tags: core-warning@
diff --git 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
@@ -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
@@ -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[]
diff --git a/docs/asciidoc/modules/notes/partials/notes.adoc 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[]