Skip to content

Commit 2260466

Browse files
committed
[DOP-19924] Fix missing logging presets in docs
1 parent 06db2d3 commit 2260466

File tree

8 files changed

+17
-15
lines changed

8 files changed

+17
-15
lines changed

Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,11 @@ venv: venv-cleanup venv-install##@Env Init venv and install poetry dependencies
2929

3030
venv-cleanup: ##@Env Cleanup venv
3131
@rm -rf .venv || true
32-
python3.12 -m venv .venv
32+
python -m venv .venv
3333
${PIP} install -U setuptools wheel pip
3434
${PIP} install poetry
35+
${PIP} install -U flake8-commas
36+
${PIP} install --no-deps sphinx-plantuml
3537

3638
venv-install: ##@Env Install requirements to venv
3739
${POETRY} config virtualenvs.create false

docs/backend/configuration/cors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _backend-configuration-cors:
1+
.. _backend-configuration-server-cors:
22

33
CORS settings
44
=============

docs/backend/configuration/logging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _configuration-logging:
1+
.. _backend-configuration-logging:
22

33
Logging settings
44
================

docs/backend/configuration/monitoring.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _configuration-server-monitoring:
1+
.. _backend-configuration-server-monitoring:
22

3-
Setup monitoring
4-
================
3+
Server monitoring
4+
=================
55

66
REST API server provides the following endpoints with Prometheus compatible metrics:
77

docs/backend/configuration/openapi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _configuration-server-openapi:
1+
.. _backend-configuration-server-openapi:
22

33
OpenAPI settings
44
================

docs/backend/configuration/static_files.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _configuration-server-static-files:
1+
.. _backend-configuration-server-static-files:
22

33
Serving static files
44
====================

syncmaster/settings/log/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,21 +65,21 @@ class LoggingSettings(BaseModel):
6565
This preset is recommended to use in environment which do not support colored output,
6666
e.g. CI jobs
6767
68-
.. literalinclude:: ../../../syncmaster/backend/settings/log/plain.yml
68+
.. literalinclude:: ../../../syncmaster/settings/log/plain.yml
6969
7070
.. dropdown:: ``colored`` preset
7171
7272
This preset is recommended to use in development environment,
7373
as it simplifies debugging. Each log record is output with color specific for a log level
7474
75-
.. literalinclude:: ../../../syncmaster/backend/settings/log/colored.yml
75+
.. literalinclude:: ../../../syncmaster/settings/log/colored.yml
7676
7777
.. dropdown:: ``json`` preset
7878
7979
This preset is recommended to use in production environment,
8080
as it allows to avoid writing complex log parsing configs. Each log record is output as JSON line
8181
82-
.. literalinclude:: ../../../syncmaster/backend/settings/log/json.yml
82+
.. literalinclude:: ../../../syncmaster/settings/log/json.yml
8383
""",
8484
),
8585
)

syncmaster/settings/server/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,17 @@ class ServerSettings(BaseModel):
4343
)
4444
cors: CORSSettings = Field(
4545
default_factory=CORSSettings,
46-
description=":ref:`CORS settings <backend-configuration-cors>`",
46+
description=":ref:`CORS settings <backend-configuration-server-cors>`",
4747
)
4848
monitoring: MonitoringSettings = Field(
4949
default_factory=MonitoringSettings,
50-
description=":ref:`Monitoring settings <backend-configuration-monitoring>`",
50+
description=":ref:`Monitoring settings <backend-configuration-server-monitoring>`",
5151
)
5252
openapi: OpenAPISettings = Field(
5353
default_factory=OpenAPISettings,
54-
description=":ref:`OpenAPI.json settings <backend-configuration-openapi>`",
54+
description=":ref:`OpenAPI.json settings <backend-configuration-server-openapi>`",
5555
)
5656
static_files: StaticFilesSettings = Field(
5757
default_factory=StaticFilesSettings,
58-
description=":ref:`Static files settings <configuration-server-static-files>`",
58+
description=":ref:`Static files settings <backend-configuration-server-static-files>`",
5959
)

0 commit comments

Comments
 (0)