Cleanup location of docs and example files (XRPLF#1195)

yinyiqian1 · Feb 20, 2024 · 27fe35a · 27fe35a
1 parent 62f55a7
commit 27fe35a
Show file tree

Hide file tree

Showing 15 changed files with 7 additions and 30 deletions.
diff --git a/CMake/install/install.cmake b/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)

diff --git a/RELEASENOTES.md b/RELEASENOTES.md
diff --git a/docker/centos/Dockerfile b/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"]
diff --git a/docs/configure-clio.md b/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:

diff --git a/cloud-example-config.json → ...examples/config/cloud-example-config.json b/cloud-example-config.json → ...examples/config/cloud-example-config.json
diff --git a/example-config.json → docs/examples/config/example-config.json b/example-config.json → docs/examples/config/example-config.json
diff --git a/examples/infrastructure/README.md → docs/examples/infrastructure/README.md b/examples/infrastructure/README.md → docs/examples/infrastructure/README.md
diff --git a/examples/infrastructure/compose.yaml → docs/examples/infrastructure/compose.yaml b/examples/infrastructure/compose.yaml → docs/examples/infrastructure/compose.yaml
diff --git a/...nfrastructure/grafana/clio_dashboard.json → ...nfrastructure/grafana/clio_dashboard.json b/...nfrastructure/grafana/clio_dashboard.json → ...nfrastructure/grafana/clio_dashboard.json
diff --git a/...frastructure/grafana/dashboard_local.yaml → ...frastructure/grafana/dashboard_local.yaml b/...frastructure/grafana/dashboard_local.yaml → ...frastructure/grafana/dashboard_local.yaml
diff --git a/...s/infrastructure/grafana/datasources.yaml → ...s/infrastructure/grafana/datasources.yaml b/...s/infrastructure/grafana/datasources.yaml → ...s/infrastructure/grafana/datasources.yaml
diff --git a/examples/infrastructure/prometheus.yaml → docs/examples/infrastructure/prometheus.yaml b/examples/infrastructure/prometheus.yaml → docs/examples/infrastructure/prometheus.yaml
diff --git a/docs/logging.md b/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`
 

diff --git a/docs/metrics-and-static-analysis.md b/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
 

diff --git a/docs/run-clio.md b/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.