Skip to content

Commit

Permalink
Merge branch 'neo4j-documentation:master' into feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
stefano-ottolenghi authored Oct 30, 2023
2 parents b099bcc + 23a2d0f commit 837608f
Show file tree
Hide file tree
Showing 48 changed files with 1,884 additions and 1,108 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
"dependencies": {
"@antora/cli": "^2.3.3",
"@antora/site-generator-default": "^2.3.3",
"@neo4j-ndl/base": "^0.8.3",
"@neo4j-ndl/base": "^2.0.0",
"font-awesome": "^4.7.0"
},
"husky": {
Expand Down
182 changes: 182 additions & 0 deletions preview-src/admonitions.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
= Admonitions



== NOTE

[NOTE]
====
You've been down _this_ road before.
`$ npm i -g @antora/cli @antora/site-generator-default`
* list 1
* list 2
Link example: link:https://neo4j.com[Neo4j]
Xref example: xref:alpha.adoc[]
====

Cum dicat putant ne.
Est in reque homero principes, meis deleniti mediocrem ad has.
Altera atomorum his ex, has cu elitr melius propriae.
Eos suscipit scaevola at.

== TIP

Cum dicat putant ne.
Est in reque homero principes, meis deleniti mediocrem ad has.
Altera atomorum his ex, has cu elitr melius propriae.

[TIP]
====
This oughta do it!
Cum dicat putant ne.
Est in reque homero principes, meis deleniti mediocrem ad has.
Altera atomorum his ex, has cu elitr melius propriae.
Eos suscipit scaevola at.
====



== IMPORTANT

[IMPORTANT]
====
Don't forget this step!
$ npm i -g @antora/cli @antora/site-generator-default
* list 1
* list 2
Link example: link:https://neo4j.com[Neo4j]
Xref example: xref:alpha.adoc[]
====



== CAUTION

[CAUTION]
====
[#inline]#I wouldn't try that if I were you.#
$ npm i -g @antora/cli @antora/site-generator-default
* list 1
* list 2
Link example: link:https://neo4j.com[Neo4j]
Xref example: xref:alpha.adoc[]
====

== WARNING

[WARNING]
====
Watch out!
$ npm i -g @antora/cli @antora/site-generator-default
* list 1
* list 2
Link example: link:https://neo4j.com[Neo4j]
Xref example: xref:alpha.adoc[]
====



== TIP

.Key Points to Remember
[TIP]
====
If you installed the CLI and the default site generator globally, you can upgrade both of them with the same command.
$ npm i -g @antora/cli @antora/site-generator-default
* list 1
* list 2
Link example: link:https://neo4j.com[Neo4j]
Xref example: xref:alpha.adoc[]
====

== Admonition block margins

[NOTE]
====
Admonition block with a single paragraph of text.
====

[NOTE]
====
Admonition block with multiple paragraphs.
This is the second paragraph.
====

[NOTE]
====
Admonition block with multiple different elements.
- List item 1
- List item 2
Paragraph of text.
====

[NOTE]
====
Admonition block with multiple different elements.
- List item 1
- List item 2
```
$ npm i -g @antora/cli @antora/site-generator-default
```
====

.Admonition with title text
[NOTE]
====
Admonition block with multiple different elements.
- List item 1
- List item 2
```
$ npm i -g @antora/cli @antora/site-generator-default
```
====

[WARNING]
====
```
$ npm i -g @antora/cli @antora/site-generator-default
```
```
$ npm i -g @antora/cli @antora/site-generator-default
```
====

.Admonition with title text
[WARNING]
====
```
$ npm i -g @antora/cli @antora/site-generator-default
```
====

Nominavi luptatum eos, an vim hinc philosophia intellegebat.
Eu mea inani iriure.
16 changes: 16 additions & 0 deletions preview-src/deprecated.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,26 @@ All headers have 'Deprecated' appended.

Lorem ipsum

Simple paragraph.

[.deprecated]
Simple paragraph marked as deprecated.


[.deprecated]

== Deprecated Heading 2

Lorem ipsum

=== Deprecated Heading 2.1

Lorem ipsum

==== Deprecated Heading 2.2

Lorem ipsum

== Deprecated Heading 3

Lorem ipsum
Expand Down
77 changes: 67 additions & 10 deletions preview-src/docs-roles.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Docs `code test` flags
:page-role: enterprise-edition not-on-aura
:page-role: not-on-aura
:page-theme: docs
// :page-labels: fabric enterprise-edition alpha test

Expand Down Expand Up @@ -76,14 +76,24 @@ Lorem ipsum

Lorem ipsum

=== H3 inside labeled section

Lorem ipsum

==== H4 inside labeled section

[role=deprecated]
== Deprecated content

Other blocks can have deprecated roles added.

.Example block title
====
Example 1 content - this example is not deprecated
Example 1 content - this example is not deprecated.
This is a second paragraph in the example.
This is the third.
====

[role=deprecated]
Expand All @@ -95,19 +105,43 @@ Example 2 content - this example is deprecated
[role=alpha]
== Alpha content


[.alpha-symbol]
[.tier-note]
This algorithm is in the alpha tier.
For more information on algorithm tiers, see <<algorithms>>.

=== Third level heading in Alpha section

Lorem ipsum


[role=beta]
== Beta content


[.beta-symbol]
[.tier-note]
This algorithm is in the beta tier.
For more information on algorithm tiers, see <<algorithms>>.


=== Third level heading in Beta section

Lorem ipsum


[role=deprecated]
== Deprecated content

Lorem ipsum


=== Third level heading in Deprecated section

Lorem ipsum


== Function symbol

[opts=header,cols="1, 1"]
Expand All @@ -132,16 +166,13 @@ Directed
Undirected

[.supported]
Monopartite
link:example.com[Heterogeneous nodes]

[.not-supported]
Multi-partite
[.allowed]
Heterogeneous relationships

[.not-supported]
Weighted

[.supported]
Unweighted
Weighted relationships
--

== List of procedures
Expand All @@ -161,4 +192,30 @@ Unweighted
<span class="label label--admin-only">Admin only</span>
+++

|===
|===

== Examples

=== Copying the data store of a database

You can use `neo4j-admin database copy` to copy the data store of a database, for example, `neo4j`.

. Stop the database named `neo4j`:
+
[source, cypher, role=noplay]
----
STOP DATABASE neo4j
----

. Copy the data store from `neo4j` to a new database called `database-copy`.
+
[TIP]
====
If you do not need an actual copy of the database, you can use the same values for `<fromDatabase>` and `<toDatabase>`.
The command replaces the original database with the newly created copy.
====
+
[source, shell]
----
bin/neo4j-admin database copy neo4j database-copy
----
Loading

0 comments on commit 837608f

Please sign in to comment.