Skip to content

Commit 63d03fa

Browse files
committed
feat docs: minor improvements for the documentation
Tests: протестировано CI, на прод не влияет commit_hash:a6d81870c50c7373d7814fbf95e5850a4ccd308b
1 parent a2d79f7 commit 63d03fa

File tree

7 files changed

+33
-20
lines changed

7 files changed

+33
-20
lines changed

samples/redis_service/static_config.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,6 @@ components_manager:
2222
redis_thread_pool_size: 8
2323
sentinel_thread_pool_size: 1
2424

25-
# /// [Sample secdist static config]
26-
# yaml
27-
default-secdist-provider: # Component that loads configuration of hosts and passwords
28-
config: /etc/redis_service/secure_data.json # Values are supposed to be stored in this file
29-
missing-ok: true # ... but if the file is missing it is still ok
30-
environment-secrets-key: SECDIST_CONFIG # ... values will be loaded from this environment value
31-
# /// [Sample secdist static config]
32-
3325
testsuite-support:
3426

3527
server:
@@ -38,6 +30,14 @@ components_manager:
3830
listener: # configuring the main listening socket...
3931
port: 8088 # ...to listen on this port and...
4032
task_processor: main-task-processor # ...process incoming requests on this task processor.
33+
34+
# /// [Sample secdist static config]
35+
# yaml
36+
default-secdist-provider: # Component that loads configuration of hosts and passwords
37+
config: /etc/redis_service/secure_data.json # Values are supposed to be stored in this file
38+
missing-ok: true # ... but if the file is missing it is still ok
39+
environment-secrets-key: SECDIST_CONFIG # ... values will be loaded from this environment value
40+
# /// [Sample secdist static config]
4141
logging:
4242
fs-task-processor: fs-task-processor
4343
loggers:

scripts/docs/en/index.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,14 +151,8 @@ are available at the
151151
* @ref clickhouse_driver
152152

153153
## Libraries
154-
155-
### Easy
156154
* @ref scripts/docs/en/userver/libraries/easy.md
157-
158-
### S3 client
159155
* @ref scripts/docs/en/userver/libraries/s3api.md
160-
161-
### grpc-reflection
162156
* @ref scripts/docs/en/userver/libraries/grpc-reflection.md
163157

164158
## Opensource

scripts/docs/en/userver/build/build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ To install userver in `ghcr.io/userver-framework/ubuntu-22.04-userver-base:lates
269269
sudo ./scripts/build_and_install_all.sh
270270
```
271271

272-
Alternatively see @ref userver_install
272+
Alternatively see @ref userver_install "userver install"
273273

274274
@note The above image is build from `scripts/docker/ubuntu-22.04-pg.dockerfile`,
275275
`scripts/docker/ubuntu-22.04.dockerfile`

scripts/docs/en/userver/dynamic_config.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ Config defaults are specified in their
269269
@ref dynamic_config_key "C++ definition".
270270
They may be overridden in the static config of `dynamic-config` component:
271271
272-
@see @ref dynamic_config_defaults_override
272+
@see @ref dynamic_config_defaults_override "Overriding dynamic configs defaults"
273273
274274
If utils::DaemonMain is used, then the default dynamic configs can
275275
be printed by passing `--print-dynamic-config-defaults` command line option.
@@ -360,7 +360,8 @@ Here is a reasonable static config for those:
360360
Components components::DynamicConfigClientUpdater and components::DynamicConfigClient
361361
use the following OpenAPI Schema to communicate with the dynamic configs server:
362362
363-
```yaml
363+
```
364+
# yaml
364365
swagger: '2.0'
365366
info:
366367
title: Dynamic configs service

scripts/docs/en/userver/libraries/grpc-reflection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
## grpc reflection
1+
## gRPC reflection
22

33
**Quality:** @ref QUALITY_TIERS "Silver Tier".
44

5-
🐙 **userver** This library provides non-blocking implementation of reflection
6-
service. It is in fact an original implementation with a few modifications to
5+
This library provides non-blocking implementation of reflection
6+
service for gRPC in 🐙 **userver**. It is in fact an original implementation with a few modifications to
77
replace all standard primitives with userver ones.
88

99

scripts/docs/en/userver/supported_platforms.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ organization page contains multiple repositories, including:
3030
* [service_template](https://github.com/userver-framework/service_template) -
3131
template of a C++ service that uses userver framework with ready-to-user
3232
build, test and CI scripts.
33+
* [pg_service_template](https://github.com/userver-framework/pg_service_template) -
34+
template of a C++ service that uses userver framework with ready-to-user PostgreSQL database,
35+
build, test and CI scripts.
36+
* [pg_grpc_service_template](https://github.com/userver-framework/pg_grpc_service_template) -
37+
template of a C++ service that uses userver framework with ready-to-user PostgreSQL database, gRPC server,
38+
build, test and CI scripts.
3339
* [uservice-dynconf](https://github.com/userver-framework/uservice-dynconf) -
3440
the service to control dynamic configs of the other userver-based services.
3541

scripts/docs/en/userver/tutorial/redis_service.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,13 @@ Static configuration of service is quite close to the configuration from @ref sc
8080

8181
@snippet samples/redis_service/static_config.yaml Redis service sample - static config
8282

83+
components::Redis takes database connection information from components::DefaultSecdistProvider, so it should be
84+
also configured:
85+
86+
@snippet samples/redis_service/static_config.yaml Sample secdist static config
87+
88+
The actual content of `secure_data.json` or `SECDIST_CONFIG` is described at components::Redis.
89+
8390

8491
### int main()
8592

@@ -177,6 +184,9 @@ See the full example:
177184
* @ref samples/redis_service/redis_service.cpp
178185
* @ref samples/redis_service/static_config.yaml
179186
* @ref samples/redis_service/CMakeLists.txt
187+
* @ref samples/redis_service/testsuite/conftest.pysamples/redis_service/CMakeLists.txt
188+
* @ref samples/redis_service/testsuite/conftest.py
189+
* @ref samples/redis_service/testsuite/test_redis.py
180190

181191
----------
182192

@@ -187,3 +197,5 @@ See the full example:
187197
@example samples/redis_service/redis_service.cpp
188198
@example samples/redis_service/static_config.yaml
189199
@example samples/redis_service/CMakeLists.txt
200+
@example samples/redis_service/testsuite/conftest.py
201+
@example samples/redis_service/testsuite/test_redis.py

0 commit comments

Comments
 (0)