Skip to content

Commit f17e8a6

Browse files
committed
Added Kora fully synced guides for RU and EN versions
1 parent 47094c6 commit f17e8a6

124 files changed

Lines changed: 64349 additions & 23172 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

mkdocs/config/en/mkdocs.yml

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,47 @@ site_dir: "../../generated/en"
66
site_name: Kora Framework 1.2.15
77
site_url: https://kora-projects.github.io/kora-docs/en/
88
nav:
9-
- Examples:
10-
- Repository examples: examples/kora-examples.md
11-
- Hello world example: examples/hello-world.md
9+
- Guides:
10+
- Introduction: examples/kora-examples.md
11+
- Basics:
12+
- Hello world: guides/getting-started.md
13+
- Introduction to Kora: guides/dependency-injection-introduction.md
14+
- Dependency Injection: guides/dependency-injection.md
15+
- HOCON Configuration: guides/config-hocon.md
16+
- YAML Configuration: guides/config-yaml.md
17+
- JSON: guides/json.md
18+
- HTTP and API:
19+
- HTTP Server: guides/http-server.md
20+
- Advanced HTTP Server: guides/http-server-advanced.md
21+
- HTTP Client: guides/http-client.md
22+
- Advanced HTTP Client: guides/http-client-advanced.md
23+
- OpenAPI HTTP Server: guides/openapi-http-server.md
24+
- Advanced OpenAPI HTTP Server: guides/openapi-http-server-advanced.md
25+
- OpenAPI HTTP Client: guides/openapi-http-client.md
26+
- Database:
27+
- JDBC Database: guides/database-jdbc.md
28+
- Advanced JDBC Database: guides/database-jdbc-advanced.md
29+
- Cassandra Database: guides/database-cassandra.md
30+
- Advanced features:
31+
- Cache: guides/cache.md
32+
- Multi-Level Cache: guides/cache-multi-level.md
33+
- Resilience: guides/resilient.md
34+
- Validation: guides/validation.md
35+
- Observability:
36+
- Metrics: guides/observability-metrics.md
37+
- Tracing: guides/observability-tracing.md
38+
- Probes: guides/observability-probes.md
39+
- Integrations:
40+
- Kafka: guides/messaging-kafka.md
41+
- gRPC Server: guides/grpc-server.md
42+
- Advanced gRPC Server: guides/grpc-server-advanced.md
43+
- gRPC Client: guides/grpc-client.md
44+
- Advanced gRPC Client: guides/grpc-client-advanced.md
45+
- S3: guides/s3.md
46+
- Testing:
47+
- Component testing: guides/testing-junit.md
48+
- Integration Testing: guides/testing-integration.md
49+
- Black-Box Testing: guides/testing-black-box.md
1250
- Documentation:
1351
- General: documentation/general.md
1452
- Dependency injection: documentation/container.md

mkdocs/config/ru/mkdocs.yml

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,47 @@ site_dir: "../../generated/ru"
66
site_name: Kora фреймворк 1.2.15
77
site_url: https://kora-projects.github.io/kora-docs/ru/
88
nav:
9-
- Примеры:
10-
- Репозиторий примеров: examples/kora-examples.md
11-
- Ознакомительный пример: examples/hello-world.md
9+
- Руководства:
10+
- Вступление: examples/kora-examples.md
11+
- Основы:
12+
- Ознакомительные приложение: guides/getting-started.md
13+
- Введение в Kora: guides/dependency-injection-introduction.md
14+
- Внедрение зависимостей: guides/dependency-injection.md
15+
- Конфигурация HOCON: guides/config-hocon.md
16+
- Конфигурация YAML: guides/config-yaml.md
17+
- JSON: guides/json.md
18+
- HTTP и API:
19+
- HTTP сервер: guides/http-server.md
20+
- HTTP сервер продвинутый: guides/http-server-advanced.md
21+
- HTTP клиент: guides/http-client.md
22+
- HTTP клиент продвинутый: guides/http-client-advanced.md
23+
- OpenAPI HTTP сервер: guides/openapi-http-server.md
24+
- OpenAPI HTTP сервер продвинутый: guides/openapi-http-server-advanced.md
25+
- OpenAPI HTTP клиент: guides/openapi-http-client.md
26+
- База данных:
27+
- База данных JDBC: guides/database-jdbc.md
28+
- База данных JDBC продвинутая: guides/database-jdbc-advanced.md
29+
- База данных Cassandra: guides/database-cassandra.md
30+
- Расширенные возможности:
31+
- Кеширование: guides/cache.md
32+
- Многоуровневое кеширование: guides/cache-multi-level.md
33+
- Отказоустойчивость: guides/resilient.md
34+
- Валидация: guides/validation.md
35+
- Наблюдаемость:
36+
- Метрики: guides/observability-metrics.md
37+
- Трассировка: guides/observability-tracing.md
38+
- Пробы: guides/observability-probes.md
39+
- Интеграции:
40+
- Kafka: guides/messaging-kafka.md
41+
- gRPC сервер: guides/grpc-server.md
42+
- gRPC сервер продвинутый: guides/grpc-server-advanced.md
43+
- gRPC клиент: guides/grpc-client.md
44+
- gRPC клиент продвинутый: guides/grpc-client-advanced.md
45+
- S3: guides/s3.md
46+
- Тестирование:
47+
- Компонентное тестирование: guides/testing-junit.md
48+
- Интеграционное тестирование: guides/testing-integration.md
49+
- Тестирование черным ящиком: guides/testing-black-box.md
1250
- Документация:
1351
- Основное: documentation/general.md
1452
- Контейнер: documentation/container.md

mkdocs/docs/en/documentation/cache.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ agent:
77
Module for creating caches based on [Caffeine](https://github.com/ben-manes/caffeine) or [Redis](https://redis.io/docs/about/)
88
using both declarative-style annotations and using their imperative style.
99

10+
For a step-by-step walkthrough before the reference details, see [Cache](../guides/cache.md) and [Multi-Level Cache](../guides/cache-multi-level.md).
11+
1012
## Caffeine { #caffeine }
1113

1214
Library-based implementation of [Caffeine](https://github.com/ben-manes/caffeine) for in-memory caches within the application.

mkdocs/docs/en/documentation/config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ agent:
66

77
Module is responsible for mapping the values of configuration files to classes in Kora and then using them for application settings.
88

9+
For a step-by-step walkthrough before the reference details, see [HOCON Configuration](../guides/config-hocon.md) and [YAML Configuration](../guides/config-yaml.md).
10+
911
## HOCON { #hocon }
1012

1113
Support for [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md) is implemented with [Typesafe Config](https://github.com/lightbend/config).

mkdocs/docs/en/documentation/container.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ injecting and then parallel initialization.
99

1010
The work of the container in Kora is divided into two parts: what is done at runtime and what is done at compile time.
1111

12+
For a step-by-step walkthrough before the reference details, see [Dependency Injection Introduction](../guides/dependency-injection-introduction.md) and [Dependency Injection](../guides/dependency-injection.md).
13+
1214
## Compile Time { #compile-time }
1315

1416
At compile time, components are searched building the dependency container of the entire application.

mkdocs/docs/en/documentation/database-cassandra.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ agent:
66

77
Module provides a repository implementation for the [Cassandra](https://cassandra.apache.org/_/cassandra-basics.html) database using the [DataStax](https://docs.datastax.com/en/developer/java-driver/4.17/) driver.
88

9+
For a step-by-step walkthrough before the reference details, see [Cassandra Database](../guides/database-cassandra.md).
10+
911
## Dependency { #dependency }
1012

1113
===! ":fontawesome-brands-java: `Java`"

mkdocs/docs/en/documentation/database-common.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Other tools often have limitations on using specific functions of a particular d
1111
or a complex program language for building queries that requires additional and considerable time to learn and master,
1212
carries a lot of non-obviousness and potential errors on the part of the developer, and also sometimes has low performance.
1313

14+
For a step-by-step walkthrough before the reference details, see [JDBC Database](../guides/database-jdbc.md) and [Advanced JDBC Database](../guides/database-jdbc-advanced.md).
15+
1416
## Entity { #entity }
1517

1618
An entity is a representation of data from a database in the form of a class with fields.

mkdocs/docs/en/documentation/database-jdbc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ agent:
77
Module provides a repository implementation based on the [JDBC](https://proselyte.net/tutorials/jdbc/introduction/) database protocol
88
and using [Hikari](https://github.com/brettwooldridge/HikariCP) for connection set management.
99

10+
For a step-by-step walkthrough before the reference details, see [JDBC Database](../guides/database-jdbc.md) and [Advanced JDBC Database](../guides/database-jdbc-advanced.md).
11+
1012
## Dependency { #dependency }
1113

1214
===! ":fontawesome-brands-java: `Java`"

mkdocs/docs/en/documentation/general.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ In order to achieve high-performance and efficient code, Kora stands on these pr
3232
- Using the most efficient implementations for integrations
3333
- Encouraging and using effective programming practices and natural language constructs
3434

35+
For a step-by-step walkthrough before the reference details, see [Creating Your First Kora Application](../guides/getting-started.md) and [Dependency Injection Introduction](../guides/dependency-injection-introduction.md).
36+
3537
## Annotation Handlers { #annotation-handlers }
3638

3739
The main pillar on which the Kora framework is built is annotation processors.
@@ -136,7 +138,7 @@ dependency `ru.tinkoff.kora:kora-parent` which requires to specify the version o
136138
}
137139
```
138140

139-
You can also check out [Hello World example](../examples/hello-world.md) for a more detailed description.
141+
You can also check out [Creating Your First Kora Application](../guides/getting-started.md) for a more detailed guided example.
140142

141143
=== ":simple-kotlin: `Kotlin`"
142144

@@ -175,7 +177,7 @@ dependency `ru.tinkoff.kora:kora-parent` which requires to specify the version o
175177
}
176178
```
177179

178-
You can also check out [Hello World example](../examples/hello-world.md) for a more detailed description.
180+
You can also check out [Creating Your First Kora Application](../guides/getting-started.md) for a more detailed guided example.
179181

180182
## Dependencies { #dependencies }
181183

@@ -330,3 +332,7 @@ This section describes the basic terms found throughout the documentation and wi
330332
- Module - [module](container.md#external-module-factory) is a pluggable dependency, often external, that provides some factory methods and new functionality to the application.
331333
- Component - [component](container.md#components) is a singleton class that implements some logic and is a dependency in a dependency container.
332334
- Aspect - is aspect logic that will extend the standard behavior of a method by via annotation before and/or after its execution.
335+
336+
## First guide
337+
338+
After reading the general overview, continue with [Creating Your First Kora Application](../guides/getting-started.md). It turns the framework basics into a small runnable HTTP service and gives the rest of the documentation a concrete shape.

mkdocs/docs/en/documentation/grpc-client.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ agent:
66

77
Module for gRPC client service support based on [grpc.io](https://grpc.io/docs/languages/java/basics/) functionality.
88

9+
For a step-by-step walkthrough before the reference details, see [gRPC Client](../guides/grpc-client.md) and [Advanced gRPC Client](../guides/grpc-client-advanced.md).
10+
911
## Dependency { #dependency }
1012

1113
===! ":fontawesome-brands-java: `Java`"

0 commit comments

Comments
 (0)