Merge branch '01-04' into 'main'

Initial upload

See merge request picodata/picodata/docs!1

README.md

-# docs
+# Тестовый портал документации продукта Picodata
 
+Здесь живёт проект Mkdocs, с помощью которого генерируется статичный сайт документации для Picodata. Содержимое репозитория попадает на сайт [docs.binary.picodata.io/picodata](docs.binary.picodata.io/picodata).
 
-
-## Getting started
-
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
-
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
-
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-
+## Cборка проекта
 ```
-cd existing_repo
-git remote add origin https://git.picodata.io/picodata/picodata/docs.git
-git branch -M main
-git push -uf origin main
+mkdocs build -d site
 ```
 
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://git.picodata.io/picodata/picodata/docs/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!).  Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+## Локальный запуск
+```
+mkdocs serve
+```
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+По умолчанию сайт будет доступен[^1] по адресу [http://127.0.0.1:8000](http://127.0.0.1:8000/).
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+## Сборка в Docker
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+В данном репозитории имееется [Dockerfile](docker/static/Dockerfile), с помощью которого можно собрать и запустить сайт внутри контейнера. Я использую следующие команды:
+```
+docker build -f docker/static/Dockerfile -t test-project-mkdocs --no-cache .
+docker run -p 8080:8080 test-project-mkdocs:latest
+```
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+## Загрузка в Heroku
+Я сделал небольшую обёртку в PHP для того чтобы статическую версию сайта можно было деплоить в Heroku. После генерации сайта следует запустить скрипт `./phpize.sh`
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+#### Настройка и деплой в первый раз[^2]:
+```
+cd site 
+heroku create
+heroku config:set NPM_CONFIG_PRODUCTION=false
+heroku config:set HOST=0.0.0.0
+heroku config:set NPM_CONFIG_PRODUCTION=false -a peaceful-brook-74799
+heroku config:set HOST=0.0.0.0 -a peaceful-brook-74799
+heroku config:set NODE_ENV=production -a peaceful-brook-74799
+git init
+git add .
+git commit -m "First Heroku commit"
+git remote add origin https://git.heroku.com/peaceful-brook-74799.git
+git push -u origin master
+```
 
-## License
-For open source projects, say how it is licensed.
+[^1]:Примечание: запуск и сборка между собой не связаны — можно запускать сайт без сборки статической версии.
+[^2]:Примечание: имя приложения будет отличаться (см. `heroku apps`)
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

docker/static/Dockerfile

+FROM python:3.10
+
+ENV SITE_SRC '/site/src'
+ENV SITE_HTML '/site/html'
+
+RUN pip install mkdocs
+
+# Generate static content
+COPY . ${SITE_SRC}
+
+EXPOSE 8080
+WORKDIR ${SITE_SRC}
+CMD ["mkdocs", "serve"]
+
+#RUN mkdir -p ${SITE_HTML} && \
+#    cd ${SITE_SRC} && \
+#    mkdocs build -d ${SITE_HTML} && \
+#    mkdocs serve

docs/benefits.md

+# Преимущества Picodata
+
+Ниже перечислены наши преимущества, доступные всем клиентам:
+
+* Гарантия сохранности данных
+* Горизонтальное масштабирование
+* Выполнение бизнес-логики внутри решетки данных
+* Продукт с открытым исходным кодом 
+* Полностью российское программное обеспечение;
+
+## Гарантия сохранности данных
+Picodata реализует [ACID-подход](https://ru.wikipedia.org/wiki/ACID), при котором любые изменения данных предварительно сохраняются в журнале на диске и реплицируются на несколько серверов. При выходе из строя любой компоненты данные автоматически восстанавливаются из существующих копий. Все операции с топологией кластера и схемой данных также атомарны.
+
+## Горизонтальное масштабирование
+Picodata разделяет данные на независимые фрагменты (шарды) по числу доступных ядер процессора. Такой подход снижает издержки на разделяемый доступ к данным, повышает утилизацию оборудования и позволяет в любой момент нарастить вычислительную мощность системы.
+
+## Выполнение бизнес-логики внутри решетки данных
+Мы в Picodata нашли способ масштабировать не только данные, но и вычисления. Наша система хранит и версионирует программный код на каждом узле кластера. Мы разработали целый ряд техник, позволяющих безопасно обновлять распределенные приложения, сохраняя целостность данных и избегая простоев системы (no downtime). Все это позволяет обеспечить бескомпромиссную скорость операций с данными.
+
+## Продукт с открытым исходным кодом
+Picodata — продукт на основе Open source, а это, в свою очередь, снижает порог входа в технологию и позволяет познакомиться с разработанным нами решением широкому кругу пользователей.
+
+## Полностью российское программное обеспечение
+СУБД Picodata создана российскими разработчиками и входит в Реестр отечественного программного обеспечения. Вся поддержка и экспертиза по внедрению доступна в России и на русском языке;

docs/index.md

+# Добро пожаловать на портал документации Picodata
+Picodata  — это распределенный сервер приложений со встроенной распределенной базой данных. Этот продукт предоставляет систему хранения данных и платформу для работы персистентных приложений на языке программирования Rust.
+Подробнее о данном программном продукте вы можете узнать на сайте [picodata.io](https://www.picodata.io).
+
+## Доступные документы и статьи
+
+* Общее описание продукта
+* [Преимущества](benefits) использования Picodata
+* Администрирование БД как [услуга](services)
+* Системные требования
+* Руководство по установке
+* Администрирование сервера приложений
\ No newline at end of file

docs/services.md

+# DBA as a Service
+Администрирование высоконагруженных критичных систем по вашему обращению. Типовые задачи, решаемые в рамках услуги:
+
+* Резервное копирование и восстановление;
+* Проактивный мониторинг доступности;
+* Регламентные работы.
+* Восстановление сегментов, кластера после сбоя;
+* Заведение пользователей, предоставление прав доступа;
+* Управление ресурсами;
+* Мониторинг состояния кластера, выявление и устранение проблем;
+* Работы по обновлению компонентов ПО кластера;.
+* Выполнение запросов на изменение настроек кластера.

mkdocs.yml

+site_name: Портал документации Picodata
+nav:
+    - Главная: index.md
+    - Преимущества: benefits.md
+    - Описание услуг: services.md
+theme: readthedocs

php-stub/composer.json

+{}

php-stub/index.php

+<?php include_once("home.html"); ?>

phpize.sh

+#!/bin/bash
+# This scripts turns the Mkdocs-generated site into a fake PHP site for  Heroku
+mv site/index.html site/home.html
+cp php-stub/* site/

site @ b8bb262e

+Subproject commit b8bb262e47f0c6b631a4cc0ce5e158d4fcd4f180