Cleanup location of docs and example files (#1195)

CMake/install/install.cmake

@@ -3,7 +3,7 @@ set (CMAKE_INSTALL_PREFIX ${CLIO_INSTALL_DIR})
 
 install (TARGETS clio_server DESTINATION bin)
 
-file (READ example-config.json config)
+file (READ docs/examples/config/example-config.json config)
 string (REGEX REPLACE "./clio_log" "/var/log/clio/" config "${config}")
 file (WRITE ${CMAKE_BINARY_DIR}/install-config.json "${config}")
 install (FILES ${CMAKE_BINARY_DIR}/install-config.json DESTINATION etc RENAME config.json)

RELEASENOTES.md

@@ -1,23 +0,0 @@
-# Release Notes
-
-This document contains the release notes for `clio_server`, an XRP Ledger API Server.
-
-To build and run `clio_server`, follow the instructions in [README.md](https://github.com/XRPLF/clio).
-
-If you find issues or have a new idea, please open [an issue](https://github.com/XRPLF/clio/issues).
-
-# Releases
-
-## 0.1.0
-
-Clio is an XRP Ledger API server. Clio is optimized for RPC calls, over websocket or JSON-RPC. Validated historical ledger and transaction data is stored in a more space efficient format, using up to 4 times less space than rippled.
-
-Clio uses Cassandra or ScyllaDB, allowing for scalable read throughput. Multiple clio nodes can share access to the same dataset, allowing for a highly available cluster of clio nodes, without the need for redundant data storage or computation.
-
-**0.1.0** is the first beta of Project Clio. It contains:
--  `./src/backend` is the BackendInterface. This provides an abstraction for reading and writing information to a database.
--  `./src/etl` is the ReportingETL. The classes in this folder are used to extract information from the P2P network and write it to a database, either locally or over the network.
--  `./src/rpc` contains RPC handlers that are called by clients. These handlers should expose the same API as rippled.
--  `./src/subscriptions` contains the SubscriptionManager. This manages publishing to clients subscribing to streams or accounts.
--  `./src/webserver` contains a flex server that handles both http/s and ws/s traffic on a single port.
--  `./unittests` simple unit tests that write to and read from a database to verify that the ETL works.

docker/centos/Dockerfile

@@ -40,10 +40,10 @@ RUN source /opt/rh/devtoolset-11/enable && cd /tmp/clio && \
 RUN mkdir output
 RUN strip clio/build/clio_server && strip clio/build/clio_tests
 RUN cp clio/build/clio_tests output/ && cp clio/build/clio_server output/
-RUN cp clio/example-config.json output/example-config.json
+RUN cp clio/docs/examples/config/example-config.json output/example-config.json
 
 FROM centos:7
 COPY --from=build /tmp/output /clio
-RUN mkdir -p /opt/clio/etc && mv /clio/example-config.json /opt/clio/etc/config.json
+RUN mkdir -p /opt/clio/etc && mv /clio/docs/examples/config/example-config.json /opt/clio/etc/config.json
 
 CMD ["/clio/clio_server", "/opt/clio/etc/config.json"]

docs/configure-clio.md

@@ -18,7 +18,7 @@ Clio needs access to a `rippled` server in order to work. The following configur
 
    - A port to handle gRPC requests, with the IP(s) of Clio specified in the `secure_gateway` entry
 
-The example configs of [rippled](https://github.com/XRPLF/rippled/blob/develop/cfg/rippled-example.cfg) and [Clio](../example-config.json) are set up in a way that minimal changes are required.
+The example configs of [rippled](https://github.com/XRPLF/rippled/blob/develop/cfg/rippled-example.cfg) and [Clio](../docs/examples/config/example-config.json) are set up in a way that minimal changes are required.
 When running locally, the only change needed is to uncomment the `port_grpc` section of the `rippled` config.
 
 If you're running Clio and `rippled` on separate machines, in addition to uncommenting the `port_grpc` section, a few other steps must be taken:

docs/logging.md

@@ -40,7 +40,7 @@ If no override is present for a given channel, that channel will log at the seve
 The log channels that can be overridden are: `Backend`, `WebServer`, `Subscriptions`, `RPC`, `ETL` and `Performance`.
 
 > [!NOTE]
-> See [example-config.json](../example-config.json) for more details.
+> See [example-config.json](../docs/examples/config/example-config.json) for more details.
 
 ## `log_to_console`
 

docs/metrics-and-static-analysis.md

@@ -10,7 +10,7 @@ To completely disable Prometheus metrics add `"prometheus": { "enabled": false }
 
 It is important to know that Clio responds to Prometheus request only if they are admin requests. If you are using the admin password feature, the same password should be provided in the Authorization header of Prometheus requests.
 
-You can find an example docker-compose file, with Prometheus and Grafana configs, in [examples/infrastructure](../examples/infrastructure/).
+You can find an example docker-compose file, with Prometheus and Grafana configs, in [examples/infrastructure](../docs/examples/infrastructure/).
 
 ## Using `clang-tidy` for static analysis
 

docs/run-clio.md

@@ -79,4 +79,4 @@ All of the above are optional.
 Clio will fallback to hardcoded defaults when these values are not specified in the config file, or if the configured values are outside of the minimum and maximum supported versions hardcoded in [src/rpc/common/APIVersion.h](../src/rpc/common/APIVersion.hpp).
 
 > [!TIP]
-> See the [example-config.json](../example-config.json) for more details.
+> See the [example-config.json](../docs/examples/config/example-config.json) for more details.