]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
notes on where the new documentation is located
authorAlan T. DeKok <aland@freeradius.org>
Wed, 24 Aug 2022 15:50:48 +0000 (11:50 -0400)
committerAlan T. DeKok <aland@freeradius.org>
Thu, 25 Aug 2022 13:20:21 +0000 (09:20 -0400)
raddb/README.adoc [new file with mode: 0644]
raddb/all.mk
raddb/certs/README.md [deleted file]

diff --git a/raddb/README.adoc b/raddb/README.adoc
new file mode 100644 (file)
index 0000000..fe65966
--- /dev/null
@@ -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.
index 9a5d0e42b1c718aca72fa3486964640aa67801c0..b774e5de429a74031a9766da7301c72203df72cf 100644 (file)
@@ -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 (file)
index c6a5e25..0000000
+++ /dev/null
@@ -1,3 +0,0 @@
-# Certificates
-
-Please see the `doc/raddb/certs/README.adoc` for full documentation.