From: Alan T. DeKok Date: Wed, 24 Aug 2022 15:50:48 +0000 (-0400) Subject: notes on where the new documentation is located X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=05453db45cc197bc038b93a1551df59762783f9e;p=thirdparty%2Ffreeradius-server.git notes on where the new documentation is located --- diff --git a/raddb/README.adoc b/raddb/README.adoc new file mode 100644 index 00000000000..fe65966c60c --- /dev/null +++ b/raddb/README.adoc @@ -0,0 +1,16 @@ += Documentation for v4 + +All of the documentation, READMEs, etc. for this directory are now +stored in the `doc/raddb` directory, which is a soft link to the +Asciidoc source. Those files are converted to HTML by Antora. + +If the server is being built from source, you can build the HTML +documentation and see if via the following commands: + +``` +make docsite +ls build/docsite/freeradius-server/latest/index.html +``` + +If the server is pre-packaged, then the HTML documentation should be +available as a separate package. diff --git a/raddb/all.mk b/raddb/all.mk index 9a5d0e42b1c..b774e5de429 100644 --- a/raddb/all.mk +++ b/raddb/all.mk @@ -15,7 +15,7 @@ DEFAULT_MODULES := always attr_filter cache_eap chap client \ LOCAL_MODULES := $(addprefix raddb/mods-enabled/,$(DEFAULT_MODULES)) -INSTALL_CERT_FILES := Makefile README.md xpextensions \ +INSTALL_CERT_FILES := Makefile xpextensions \ ca.cnf server.cnf ocsp.cnf inner-server.cnf \ client.cnf bootstrap diff --git a/raddb/certs/README.md b/raddb/certs/README.md deleted file mode 100644 index c6a5e2550c0..00000000000 --- a/raddb/certs/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Certificates - -Please see the `doc/raddb/certs/README.adoc` for full documentation.