From: nolade Date: Fri, 24 Jan 2025 18:44:40 +0000 (-0500) Subject: remove merge text X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a28fdbec5c9fac33e702baa51b5eff8e96829ef5;p=thirdparty%2Ffreeradius-server.git remove merge text Files Updates to remove merge conflict texts (squashed) Updated xrefs/hyperlinks and formatting Index and nav files tweaked to urls resolved. Other hyperlinks fixed & format tweaks. --- diff --git a/doc/antora/modules/ROOT/pages/index.adoc b/doc/antora/modules/ROOT/pages/index.adoc index df45e085f83..1c9d0843820 100644 --- a/doc/antora/modules/ROOT/pages/index.adoc +++ b/doc/antora/modules/ROOT/pages/index.adoc @@ -36,12 +36,12 @@ Everything in the server is fully documented, and there are many The documentation is split into sections by subject area, oganized by desired outcome. At a high level, the subject areas describe: -* xref:concepts:index.adoc[Concepts] and introduction for newcomers. -* xref:installation:index.adoc[Installing] and xref:installation:upgrade.adoc[upgrading] FreeRADIUS. -* The syntax of the xref:reference:unlang/index.adoc[unlang] processing language. +* xref:concepts:index.adoc[Concepts] and introduction for newcomers * The xref:reference:raddb/index.adoc[configuration files] located in `/etc/raddb/`, or `/etc/freeradius/` -* Various xref:howto:index.adoc[how-to] guides. -* xref:developers:index.adoc[Developer documentation]. +* The syntax of the xref:reference:unlang/index.adoc[unlang] processing language +* Various xref:howto:index.adoc[how-to] guides +* xref:howto:installation/index.adoc[Installing] and xref:howto:installation/upgrade.adoc[upgrading] FreeRADIUS +* xref:developers:index.adoc[Developer documentation] This organization means that for example, the `ldap` module will have documentation located in multiple places. We feel that organizing the diff --git a/doc/antora/modules/developers/pages/index.adoc b/doc/antora/modules/developers/pages/index.adoc index 46c1b552e14..d0fecc1b773 100644 --- a/doc/antora/modules/developers/pages/index.adoc +++ b/doc/antora/modules/developers/pages/index.adoc @@ -8,7 +8,7 @@ https://doc.freeradius.org/[Doxygen] site. # Instructions for Developers As the name suggests, FreeRADIUS is developed under the GNU -General Public License, Version 2(GPLv2). +General Public License, Version 2 (GPLv2). We invite anyone to use and contribute code to the project. The following information should prove useful for potential contributors. @@ -25,9 +25,9 @@ the wiki. We encourage everyone who might contribute code to join the FreeRADIUS development list(http://www.freeradius.org/list/devel.html). This list is highly technical and isn't for most users of the server. -For normal discussion of the server and how to use it, there's a -FreeRADIUS user-list. -You should *only* subscribe to the development list if you are +For normal discussion of the server and how to use it, subscribe to the +https://lists.freeradius.org/mailman/listinfo/freeradius-users[FreeRADIUS user-list]. +*Only* subscribe to the development list if you are interested in writing software for the new server. diff --git a/doc/antora/modules/howto/pages/modules/rest/index.adoc b/doc/antora/modules/howto/pages/modules/rest/index.adoc index 315ab9e9980..91e6ea76e12 100644 --- a/doc/antora/modules/howto/pages/modules/rest/index.adoc +++ b/doc/antora/modules/howto/pages/modules/rest/index.adoc @@ -23,7 +23,7 @@ data in that format the REST module expected. == xref:modules/rest/custom_data.adoc[Calling REST endpoints with a custom data format] The REST module can also communicate with arbitrary REST endpoints, -and versions ≥ v4.0.x include a JSON module xref:reference:raddb/mods-available/json[JSON] +and versions ≥ v4.0.x include a JSON module xref:mods-available/json.adoc[JSON] which allows mapping elements of a JSON response to FreeRADIUS. If you're attempting to integrate an existing REST API, this section will provide diff --git a/doc/antora/modules/installation/pages/debian.adoc b/doc/antora/modules/installation/pages/debian.adoc index 03bae8d0189..48aa1715898 100644 --- a/doc/antora/modules/installation/pages/debian.adoc +++ b/doc/antora/modules/installation/pages/debian.adoc @@ -1,4 +1,4 @@ -= 2 Ways of installing FreeRadius on Ubuntu += Installing FreeRadius on Ubuntu * Installing from repositories * Installing from source @@ -60,14 +60,17 @@ Documentation and files for creation of certificates are in : cd /usr/share/doc/freeradius ---- -== Installing from source : +== Installing from source Installing from source can be daunting for people who never did it but as long as you read the output of the building process, it should tell you what went wrong or what is missing. -First step is to get the source. 2 places that currently offer the material : -* freeradius.org : http://freeradius.org/download.html(http://freeradius.org/download.html) -* GitHub : https://github.com/FreeRADIUS/freeradius-server(https://github.com/FreeRADIUS/freeradius-server) On GitHub select the branch you wish to install and press clone or download. +======= +Your first step is to download the source files which can be found on one of the following sites: + + 1. http://freeradius.org/download.html[Freeradius.org] - Choose the latest release by selecting the relevant button. + + 2. https://github.com/FreeRADIUS/freeradius-server[Github] - Select the branch you wish to install and press clone or download. Make sure unzip or any other utility that can extract the zip is installed. If not : ---- diff --git a/doc/antora/modules/installation/pages/source.adoc b/doc/antora/modules/installation/pages/source.adoc index cbfe666efef..d43d4ebd48f 100644 --- a/doc/antora/modules/installation/pages/source.adoc +++ b/doc/antora/modules/installation/pages/source.adoc @@ -194,7 +194,4 @@ Configuring and running the server MAY be complicated. Many modules have Please read the documentation in the doc/ directory. The comments in the configuration files also contain a lot of documentation. -If you have any additional issues, the FAQ is also a good place to -start. - -https://wiki.freeradius.org/guide/FAQ +If you have any additional issues, refer to the https://wiki.freeradius.org/guide/FAQ[FAQ] for more help.