Документы – это окно, через которое мы можем заглянуть в мышление людей. Джон Никол.
(English version может быть available here фьючерсная ссылка )
README - это лицо проекта и у нас есть всего 7 секунд, что бы гость, зашедший в проект понял: что здесь такое и как он может это использовать.
Вы наверняка задавались вопросами типа:
- Как написать хороший README ?
- Какова структура README?
- Как быстро сделать понятную документацию?
- Как поддерживать ее актуальность?
- Как делится документацией?
Результаты исследования этих вопросов и мой вариант их решения изложен в Главе 4 документации к этому проекту.
Документация на русском языке расположена в папке documents и доступна в трех форматах:
- текстовом ./documentation/md_ru/
- гипертекстовом ./documentation/html_ru/index.html
- web-сайте https://maxpod.gitlab.io/rebrain-devops-task-checkout
| Директория | Содержание |
|---|---|
| файлы в корне | |
| - contens.rme | корневой модуль rme (см. главу 3.1 DevOps-документации) |
| - doc_me.sh | скрипт сборки документации (см. главу 3.1 DevOps-документации) |
| - nginx.conf | файл-результат выполнения задания 2 |
| - README.md | данный файл, описание проекта |
| папки проекта | |
| data_of_my_project | папка с файлами некоего проекта для примера |
| documentation | документация к проекту |
| - html_ru | документация в формате html, для просмотра откройте index.html |
| - hugo | генератор статических сайтов Hugo c шаблоном сайта |
| - md_ru | текстовая документация в формате MD-постов |
| - readme_ru | статические модули rme (см. главу 3.1 DevOps-документации) и скрипт-сборщик readme |
Максим Подгорных a.k.a Dr'MaxPod maxim@universe.su @MaximPdogornykh
Free
Особая благодраность компании REBRAIN и лично Василию Озерову за открытую дверь в паралельную вселенную IT технологий, а то я тут в сибирском лесу заблудился слегка / www.rebrainme.com /