Skip to content

Commit 0a72224

Browse files
annamikhailovapskannamikhailovapsk
authored
[DOP-27545] docs(mddocs): add en docs from docs_rework (#351)
1 parent 7e8fb08 commit 0a72224

99 files changed

Lines changed: 2281 additions & 0 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.

‎mddocs/_static/architecture.png‎

85.1 KB
Loading

‎mddocs/_static/custom.css‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.logo {
2+
width: 200px !important;
3+
}

‎mddocs/_static/openapi.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"openapi": "3.1.0",
3+
"version": "unknown",
4+
"info": {
5+
"title": "Generated in CI",
6+
"version": "unknown"
7+
},
8+
"paths": {}
9+
}

‎mddocs/_static/redoc.html‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
2+
<!DOCTYPE html>
3+
<html>
4+
<head>
5+
<title>SyncMaster - ReDoc</title>
6+
<!-- needed for adaptive design -->
7+
<meta charset="utf-8"/>
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
10+
<link rel="shortcut icon" href="../../_static/icon.svg">
11+
<!--
12+
ReDoc doesn't change outer page styles
13+
-->
14+
<style>
15+
body {
16+
margin: 0;
17+
padding: 0;
18+
}
19+
</style>
20+
</head>
21+
<body>
22+
<noscript>
23+
ReDoc requires Javascript to function. Please enable it to browse the documentation.
24+
</noscript>
25+
<redoc spec-url="../../_static/openapi.json"></redoc>
26+
<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"></script>
27+
</body>
28+
</html>

‎mddocs/_static/swagger.html‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1" />
6+
<meta
7+
name="description"
8+
content="SwaggerUI"
9+
/>
10+
<title>SwaggerUI</title>
11+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css" />
12+
<link rel="shortcut icon" href="../../_static/icon.svg">
13+
</head>
14+
<body>
15+
<div id="swagger-ui"></div>
16+
<script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js" crossorigin></script>
17+
<script>
18+
window.onload = () => {
19+
window.ui = SwaggerUIBundle({
20+
url: '../../_static/openapi.json',
21+
dom_id: '#swagger-ui',
22+
});
23+
};
24+
</script>
25+
</body>
26+
</html>

‎mddocs/changelog.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Changelog { #changelog }
2+
3+
!include(../../changelog/index.md)

‎mddocs/changelog/0.1.1.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# 0.1.1 (2024-03-29) { #0.1.1 }
2+
3+
SyncMaster is now open source!

‎mddocs/changelog/0.1.2.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# 0.1.2 (2024-04-15) { #0.1.2 }
2+
3+
## Features
4+
5+
- Rename `syncmaster.backend.main` module to `syncmaster.backend`. It now also accepts the same args as `uvicorn`. [#35](https://github.com/MobileTeleSystems/syncmaster/issues/35)
6+
- Add `syncmaster.db.migrations` module to run `alembic` with proper config. [#35](https://github.com/MobileTeleSystems/syncmaster/issues/35)
7+
- Change backend and worker images to use entrypoint. [#35](https://github.com/MobileTeleSystems/syncmaster/issues/35)
8+
9+
## Improvements
10+
11+
- Run database migrations in the entrypoint of backend image, before starting the backend server. [#35](https://github.com/MobileTeleSystems/syncmaster/issues/35)
12+
- Add healthchecks to example `docker-compose.yml`. [#35](https://github.com/MobileTeleSystems/syncmaster/issues/35)

‎mddocs/changelog/0.1.3.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 0.1.3 (2024-04-15) { #0.1.3 }
2+
3+
## Bug Fixes
4+
5+
Fix backend image entrypoint.

‎mddocs/changelog/0.1.4.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# 0.1.4 (2024-04-15) { #0.1.4 }
2+
3+
## Bug Fixes
4+
5+
- Fix missing backend factory for uvicorn.
6+
- Fix missing `kinit` executable in worker image.

0 commit comments

Comments
 (0)