Skip to content

Commit

Permalink
Use static manpages rather than generating them from asciidoc
Browse files Browse the repository at this point in the history
  • Loading branch information
benbc authored and digitalstain committed Oct 26, 2016
1 parent 7981595 commit b8adb4e
Show file tree
Hide file tree
Showing 28 changed files with 848 additions and 536 deletions.
5 changes: 1 addition & 4 deletions community/neo4j/src/docs/ops/upgrades.asciidoc
Expand Up @@ -2,7 +2,6 @@
= Upgrading

:manual-ha-upgrade-guide: {operations-manual-base-uri}/#ha-upgrade-guide
:manual-neo4j-admin-manpage: {operations-manual-base-uri}/#man-neo4j-admin
:neo4j-releases-download-page: http://neo4j.com/download/other-releases

This section describes upgrading a _single_ Neo4j instance.
Expand Down Expand Up @@ -52,9 +51,7 @@ available with Neo4j Enterprise, ensure that backups have completed successfully

. Install Neo4j {neo4j-version}.
. Review the settings in the configuration files in the previous installation, and transfer any custom settings to the {neo4j-version} installation. Since many settings have been changed between Neo4j 2.x and Neo4j 3.0, it is advisable to use the `config-migrator` to migrate the config files for you. The `config-migrator` can be found in the `tools` directory, and can be invoked with a command like: `java -jar config-migrator.jar path/to/neo4j2.3 path/to/neo4j3.0`. Take note of any warnings printed, and manually review the edited config files produced.
. Import your data from the old installation using `neo4j-admin import --mode=database --database=<database-name> --from=<source-directory>` (for details, see
ifndef::upgradetext[<<neo4j-admin-manpage, the man page>>).]
ifdef::upgradetext[the man page at {manual-neo4j-admin-manpage}).]
. Import your data from the old installation using `neo4j-admin import --mode=database --database=<database-name> --from=<source-directory>` (for details, see `neo4j-admin help import`).
. If the database is not called `graph.db`, set `dbms.active_database` in `neo4j.conf` to the name of the database.
. Set `dbms.allow_format_migration=true` in `neo4j.conf` of the {neo4j-version} installation.
Neo4j will fail to start without this configuration.
Expand Down
81 changes: 0 additions & 81 deletions manual/backup/src/docs/man/neo4j-backup.1.asciidoc

This file was deleted.

25 changes: 0 additions & 25 deletions manual/contents/src/manpages.asciidoc

This file was deleted.

6 changes: 0 additions & 6 deletions manual/contents/src/neo4j-manual.asciidoc
Expand Up @@ -53,9 +53,3 @@ include::terminology.asciidoc[]
:leveloffset: 0

include::resources.asciidoc[]

:leveloffset: 0

include::manpages.asciidoc[]


1 change: 0 additions & 1 deletion manual/contents/src/preface/preface.asciidoc
Expand Up @@ -15,7 +15,6 @@ The main parts of the manual are:
* <<advanced-usage>> -- using Neo4j in more advanced ways.
* <<terminology>> -- terminology about graph databases.
* <<resources>> -- find additional documentation resources.
* <<manpages>> -- command line documentation.

The material is practical, technical, and focused on answering specific questions.
It addresses how things work, what to do and what to avoid to successfully run Neo4j in a production environment.
Expand Down
56 changes: 0 additions & 56 deletions manual/import-tool/src/docs/man/neo4j-import.1.asciidoc

This file was deleted.

4 changes: 1 addition & 3 deletions manual/manual/Makefile
Expand Up @@ -14,7 +14,5 @@ make_dir = $(tools_dir)/make

include $(make_dir)/context-manual.make

manpage_list = "neo4j server-docs" "neo4j-admin server-docs" "neo4j-shell shell-docs" "neo4j-backup backup-docs" "neo4j-import import-tool-docs"

webhelp_dist: initialize install-extensions manpages copy-images docbook docbook-html year-check
webhelp_dist: initialize install-extensions copy-images docbook docbook-html year-check
# cleanup
45 changes: 0 additions & 45 deletions manual/manual/assemblies/manpages-enterprise.xml

This file was deleted.

44 changes: 0 additions & 44 deletions manual/manual/assemblies/manpages.xml

This file was deleted.

60 changes: 0 additions & 60 deletions manual/manual/pom.xml
Expand Up @@ -281,23 +281,6 @@
<artifactId>docbkx-maven-plugin</artifactId>
<version>2.0.16</version>
<executions>
<execution>
<id>generate-manpages</id>
<phase>process-classes</phase>
<goals>
<goal>generate-manpages</goal>
</goals>
<configuration>
<sourceDirectory>${project.build.directory}/manpages</sourceDirectory>
<postProcess>
<gzip src="${project.build.directory}/docbkx/manpages/man1/neo4j.1" destfile="${project.build.directory}/manpages/neo4j.1.gz"/>
<gzip src="${project.build.directory}/docbkx/manpages/man1/neo4j-admin.1" destfile="${project.build.directory}/manpages/neo4j-admin.1.gz"/>
<gzip src="${project.build.directory}/docbkx/manpages/man1/neo4j-shell.1" destfile="${project.build.directory}/manpages/neo4j-shell.1.gz"/>
<gzip src="${project.build.directory}/docbkx/manpages/man1/neo4j-backup.1" destfile="${project.build.directory}/manpages/neo4j-backup.1.gz"/>
<gzip src="${project.build.directory}/docbkx/manpages/man1/neo4j-import.1" destfile="${project.build.directory}/manpages/neo4j-import.1.gz"/>
</postProcess>
</configuration>
</execution>
<execution>
<id>generate-webhelp-html</id>
<phase>process-classes</phase>
Expand Down Expand Up @@ -328,13 +311,6 @@
section toc
set toc,title
</generateToc>
<preProcess>
<move todir="${project.build.directory}" overwrite="true">
<fileset dir="${project.build.directory}/manpages">
<include name="*.xml"/>
</fileset>
</move>
</preProcess>
<postProcess>
<copy todir="${project.build.directory}/docbkx/webhelp/images" overwrite="true">
<fileset dir="${docs.resources}/images"/>
Expand Down Expand Up @@ -465,42 +441,6 @@
<tag>${releaseVersion}</tag>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<id>manpages</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<descriptors>
<descriptor>assemblies/manpages.xml</descriptor>
</descriptors>
<finalName>${project.artifactId}-${project.version}</finalName>
<appendAssemblyId>true</appendAssemblyId>
<attach>true</attach>
</configuration>
</execution>
<execution>
<id>manpagesenterprise</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<descriptors>
<descriptor>assemblies/manpages-enterprise.xml</descriptor>
</descriptors>
<finalName>${project.artifactId}-${project.version}</finalName>
<appendAssemblyId>true</appendAssemblyId>
<attach>true</attach>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

Expand Down

0 comments on commit b8adb4e

Please sign in to comment.