From 87616b2d66dcad0dbab896f495333d1ca47978de Mon Sep 17 00:00:00 2001 From: Alena Batitskaia Date: Tue, 23 Jul 2024 07:55:18 -0500 Subject: [PATCH] =?UTF-8?q?=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=D0=B8=D0=B5=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD?= =?UTF-8?q?=D1=82=D0=B0=D1=86=D0=B8=D0=B8=20=D0=B4=D0=BB=D1=8F=20=D0=BA?= =?UTF-8?q?=D0=BE=D0=BD=D1=82=D1=80=D0=B8=D0=B1=D1=8C=D1=8E=D1=82=D0=BE?= =?UTF-8?q?=D1=80=D0=BE=D0=B2=20(#5315)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Обновляет главный ридми и ридми в docs * Вносит правки после ревью * Обновляет ссылки Co-authored-by: Svetlana Korobtseva --------- Co-authored-by: Svetlana Korobtseva --- README.md | 31 ++++++++++--------------------- docs/README.md | 24 +++++++++++++++++++++++- 2 files changed, 33 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 3ee6d119d9..1bd3f05bc6 100644 --- a/README.md +++ b/README.md @@ -10,34 +10,23 @@ Дока — это добрая энциклопедия для веб-разработчиков. Наша цель — сделать документацию по веб-разработке практичной, понятной и не унылой. -## Как устроена Дока - -Дока состоит из двух репозиториев: [платформа](https://github.com/doka-guide/platform) на базе [Eleventy](https://www.11ty.dev) собирает статьи из репозитория с контентом (мы сейчас в нём), и на выходе получается наш красивый [сайт](https://doka.guide/). - 📘 Этот репозиторий содержит только тексты статей и материалов проекта «[Дока](https://doka.guide/)»! -## Внесите свой вклад - -Дока постоянно развивается. Вы можете писать статьи, помогать с разработкой или редактированием. Вы можете всё! Прекрасный мир опенсорса 🧚‍♀️ - -Почитайте, [чем можно помочь Доке](docs/contributing.md). - Присоединяйтесь к [нашему сообществу в Телеграм](https://t.me/doka_guide), чтобы быть в курсе последних новостей, или к [чату](https://t.me/+qYFPI2mExuQxZTFi), чтобы пообщаться, задать вопрос и просто хорошо провести время. -## Станьте автором +## Как начать? -Хотите писать для Доки? Вам поможет [руководство по стилю](docs/styleguide.md). +Все тексты хранятся в формате Маркдаун, демо — в HTML. Это облегчает работу с ними и не требует дополнительных инструментов. -Прочитали и готовы? +1. Сделайте форк этого репозитория. +1. Склонируйте форк репозитория на компьютер. +1. Откройте папку репозитория в редакторе. +1. Создайте новую ветку. +1. Работайте над материалом. +1. В процессе работы делайте коммиты. +1. Когда готовы к ревью — создайте пулреквест в исходный репозиторий Доки. -1. Форкните [репозиторий с контентом](https://github.com/doka-guide/content) и склонируйте его к себе. -1. Определитесь с форматом материала (дока или статья) и, - - если такой статьи ещё нет, откройте форк в терминале и введите `./new.sh`. Когда вы ответите на несколько вопросов, останется открыть созданный файл `index.md` и начать писать. Также можно создать статью вручную [по инструкции](docs/contributing.md). - - если статья уже есть, откройте её, и можете работать с текстом: вносить изменения, добавлять что-то полезное. -1. Напишите статью (не забывайте сверяться с [руководством по стилю](docs/styleguide.md)). Всё, что хорошо выглядит в маркдауне, будет хорошо выглядеть на сайте. Если вы хотите предпросматривать статью локально, почитайте [инструкцию по предпросмотру](docs/preview.md). -1. Дополнительные материалы: картинки, [демки](docs/demos/index.md), блок «[На практике](docs/practice.md)» сохраняйте в ту же папку, в подпапки _images_, _demos_, _practice_ и так далее. -1. Запустите автоматическую проверку орфографии командой `npx yaspeller --only-errors --file-extensions ".md,.html" *` (вы можете отредактировать это выражение, чтобы протестировать только те файлы, которые вы меняли). -1. Закончили? Создайте пулреквест. Вот и всё! После небольшой проверки ваш материал появится на сайте Доки! +[Документация](docs/README.md) --- diff --git a/docs/README.md b/docs/README.md index 65c708dde6..9e6ac40930 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,28 @@ # Документация к Доке -Даже документации нужна своя документация! +## Как устроена Дока + +Дока состоит из двух репозиториев: [платформа](https://github.com/doka-guide/platform) на базе [Eleventy](https://www.11ty.dev) собирает статьи из репозитория с контентом (мы сейчас в нём), и на выходе получается наш красивый [сайт](https://doka.guide/). + +## Внесите свой вклад + +Дока постоянно развивается. Вы можете писать статьи, помогать с разработкой или редактированием. Вы можете всё! Прекрасный мир опенсорса 🧚‍♀️ + +Почитайте, [чем можно помочь Доке](contributing.md). + +## Станьте автором + +Хотите писать для Доки? + +1. Форкните этот [репозиторий с контентом](https://github.com/doka-guide/content) и склонируйте его к себе. +1. Определитесь с форматом материала (дока или статья) и, + - если такой статьи ещё нет, откройте форк в терминале и введите `./new.sh`. Когда вы ответите на несколько вопросов, останется открыть созданный файл `index.md` и начать писать. Также можно создать статью вручную [по инструкции](contributing.md). + - если статья уже есть, откройте её, и можете работать с текстом: вносить изменения, добавлять что-то полезное. +1. Напишите статью (не забывайте сверяться с [руководством по стилю](styleguide.md)). Всё, что хорошо выглядит в маркдауне, будет хорошо выглядеть на сайте. Если вы хотите предпросматривать статью локально, почитайте [инструкцию по предпросмотру](preview.md). +1. Дополнительные материалы: картинки, [демки](demos/index.md), блок «[На практике](practice.md)» сохраняйте в ту же папку, в подпапки _images_, _demos_, _practice_ и так далее. +1. Закончили? Создайте пулреквест. Вот и всё! После небольшой проверки ваш материал появится на сайте Доки! + +--- ## Как писать в Доку