From: Matthew Newton Date: Mon, 26 Aug 2019 21:12:18 +0000 (+0100) Subject: doc: move 'upgrading' to 'install & upgrade' section X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fc36f99c6fc27222e62701c8bc94fd115cd876b2;p=thirdparty%2Ffreeradius-server.git doc: move 'upgrading' to 'install & upgrade' section --- diff --git a/doc/antora/antora.yml b/doc/antora/antora.yml index 19b8b31f63a..3b7bbecef7e 100644 --- a/doc/antora/antora.yml +++ b/doc/antora/antora.yml @@ -13,5 +13,4 @@ nav: - modules/howto/nav.adoc - modules/unlang/nav.adoc - modules/developers/nav.adoc -- modules/upgrade/nav.adoc - modules/raddb/nav.adoc diff --git a/doc/antora/modules/ROOT/pages/index.adoc b/doc/antora/modules/ROOT/pages/index.adoc index 7dfe65a546c..0c72b622dda 100644 --- a/doc/antora/modules/ROOT/pages/index.adoc +++ b/doc/antora/modules/ROOT/pages/index.adoc @@ -33,7 +33,7 @@ desired outcome. At a high level, the subject areas describe: * The syntax of the xref:unlang:index.adoc[unlang] processing language. * The xref:raddb:index.adoc[configuration files] located in `/etc/raddb/`, or `/etc/freeradius/` * Various xref:howto:index.adoc[how-to] guides. -* xref:upgrade:index.adoc[Upgrading] from a previous version of FreeRADIUS. +* xref:installation:upgrade.adoc[Upgrading] from a previous version of FreeRADIUS. * xref:developers:index.adoc[Developer documentation]. This organization means that for example, the `ldap` module will have @@ -69,8 +69,8 @@ All of these limitations and more have been removed. The downside of these changes is that the some of the configuration has been changed. Administrators who have version 3 and wish to upgrade to version 4 -should read the xref:upgrade:index.adoc[upgrading] documentation. That -documentation explains the differences between the two versions, and +should read the xref:installation:upgrade.adoc[upgrading] documentation. +That documentation explains the differences between the two versions, and how an existing configuration can be reproduced in the latest release. We do _not_ recommend using version 3 configuration files with version 4. The configuration files are _not_ compatible across a diff --git a/doc/antora/modules/installation/nav.adoc b/doc/antora/modules/installation/nav.adoc index b592f0e3ca8..238e27bebac 100644 --- a/doc/antora/modules/installation/nav.adoc +++ b/doc/antora/modules/installation/nav.adoc @@ -2,6 +2,7 @@ ** xref:packages.adoc[Install from packages] ** xref:dependencies.adoc[Dependencies] ** xref:source.adoc[Build from source] +** xref:upgrade.adoc[Upgrading from v3 to v4] ** Building Packages *** xref:build_deb.adoc[Debian and Ubuntu] *** xref:build_rpm.adoc[RedHat and CentOS] diff --git a/doc/antora/modules/installation/pages/source.adoc b/doc/antora/modules/installation/pages/source.adoc index 941384def41..08a05786271 100644 --- a/doc/antora/modules/installation/pages/source.adoc +++ b/doc/antora/modules/installation/pages/source.adoc @@ -66,7 +66,7 @@ this may cause undesired behavior and failure to operate correctly. The initial output from running in debugging mode (`radiusd -X`) will tell you which configuration files are being used. See -xref:upgrade:index.adoc[Upgrading] for information about +xref:installation:upgrade.adoc[Upgrading] for information about upgrading from older versions. There _may_ be changes in the dictionary files which are required for a new version of the software. These files will not be installed over your current @@ -95,7 +95,7 @@ major versions of the server. (For example - version 2 to version 3, or version 3 to version 4. For details on what has changed between the version, see the -xref:upgrade:index.adoc[upgrade] guide. +xref:installation:upgrade.adoc[upgrade] guide. We _strongly_ recommend that new major versions be installed in a different location than any existing installations. Any local policies diff --git a/doc/antora/modules/upgrade/pages/index.adoc b/doc/antora/modules/installation/pages/upgrade.adoc similarity index 100% rename from doc/antora/modules/upgrade/pages/index.adoc rename to doc/antora/modules/installation/pages/upgrade.adoc diff --git a/doc/antora/modules/raddb/pages/index.adoc b/doc/antora/modules/raddb/pages/index.adoc index 81b17b42139..69b6757c299 100644 --- a/doc/antora/modules/raddb/pages/index.adoc +++ b/doc/antora/modules/raddb/pages/index.adoc @@ -98,8 +98,8 @@ Note that unlike v3, there are no longer any `authorize`, been renamed. This change was necessary in order to simplify the operation of the server, and to better support multiple protocols. -Please see the xref:upgrade:index.adoc[upgrade] file for more information -about these changes. +Please see the xref:installation:upgrade.adoc[upgrade] file for more +information about these changes. The `sites-available/` directory contains many files. Each file is a worked example of how to achieve a particular goal using FreeRADIUS. We diff --git a/doc/antora/modules/upgrade/nav.adoc b/doc/antora/modules/upgrade/nav.adoc deleted file mode 100644 index 912e5f03b71..00000000000 --- a/doc/antora/modules/upgrade/nav.adoc +++ /dev/null @@ -1 +0,0 @@ -* xref:index.adoc[Upgrading from v3 to v4] diff --git a/doc/upgrade b/doc/upgrade deleted file mode 120000 index 193b7546d43..00000000000 --- a/doc/upgrade +++ /dev/null @@ -1 +0,0 @@ -antora/modules/upgrade/pages/ \ No newline at end of file