Update Readme

Author: Alexey Vasilyev

README.md

@@ -1,79 +1,73 @@
 # Setup через docker, docker-compose и dip
 
+- для начала нужно зарегаться в algolia.com и получить API-ключи (у dev.to хорошие сиды, но они завязаны на algolia, поэтому приходится этим заниматься)
+  - cp .env-example .env (.env is gitignored)
+  - в .env вставить свои ключи от Algolia
 - gem install dip (maybe change .ruby-version file with your ruby ver)
 - cd .dev_to
 - docker-compose build
-- For algolia not to brake setup
-  - cp .env-example .env (.env is gitignored)
-  - in .env paste your Algolia keys
 - dip provision
 - docker-compose up
 - open localhost:3000 in your browser
 
 After setup you can
 
+- dip bash - to do any other commands or just to peek around
 - dip bundle - to bundle install after adding gems
 - dip setup - to rerun bin/setup
-- dip bash - to do any other commands or just to peek around
+
 
 # Задание №4
 
 ## Цели выполнения задания
 
-- Попрактиковаться в настройке мониторинга
-- Попрактиковаться в поиске возможностей для оптимизации
-- Попрактиковаться в проверке гипотез и обосновании предложений по оптимизации
-- Познакомиться с интересным живым `Rails` `open-source` проектом
+- Попрактиковаться в подключении APM
+- Попрактиковаться в проверке гипотез, бенчмарках и обосновании предложений по оптимизации
 
 ## Подготовка
 
-- Завести `dev.to` локально (прямо в этом репозитории, не нужно клонировать `dev.to` от них, иначе будут отличаться версии)
+- Завести `dev.to` локально через docker, по инструкции выше
 - Настроить свой `NewRelic` для мониторинга локального `dev.to`
-- Настроить свой `Skylight` / `Scout` / `Datadog` для мониторинга локального dev.to
-- Настроить свой `Prometheus` + `Grafana` для мониторинга локального `dev.to`
 - Настроить `rack-mini-profiler`
-- Настроить `rails-panel`
-- Сделать возможность запуска проекта в `local_production`
 
-### local_production
+## Оптимизация
 
-Можно либо
+Инструменты мониторинга показывают, что самой горячей точкой является главная страница, `StoriesController#index`.
 
-- сделать новый `environment`, `local_production`
-- использовать `production`, но найти способ переопределить нужные настройки локально
+В частности, заметное время занимает рендеринг `partial`-ов `_single_story.html.erb`.
 
-Основное, что должно отличать ваш `local_production` от `development`:
+Рассмотрите гипотезу о том, что можно закешировать `<%= render "articles/single_story", story: story %>` в `_main_stories_feed.html.erb` и это даст заметный эффект. (В этот паршл входят счётчики лайков и комментариев, они не заморозятся?)
 
-- `cache_classes: true`
-- `eager_load: true`
-- `perform_caching: true`
-- `assets_debug: false`
-- `assets_compile: false`
+- Не забудьте включить локальное кэширование (`touch tmp/caching-dev.txt` / `rails dev:cache`)
+- Сделайте `benchmark` с помощью `ab` (`ab -n 100 -c 5 http://localhost:3000/`)
+- Сделайте оптимизацию
+- Перезапустите `benchmark` и сравните результаты
 
-Для работы потребуется прекомпиляция ассетов `rake assets:precompile`
+Если вы посчитаете, что применить кэширование здесь целесообразно, оформите обоснованный `PR` с этим предложением. Напишите в описании `PR`, какая была гипотеза, откуда она взялась, как вы проверяли гипотезу, какие результаты получили. Приложите скриншоты графиков APM, если на них виден эффект оптимизации.
 
-## Оптимизация
 
-Все инструменты мониторинга показывают, что самой горячей точкой является главная страница, `StoriesController#index`.
+## Бонусная программа
+- Попробовать что-то ещё, поимио `NewRelic` - `datadog`, `scout`, `skylight`, etc...
+- Настроить `local_production` окружение, сравнить скорость работы с обычным `development`
 
-В частности, заметное время занимает рендеринг `partial`-ов `_single_story.html.erb`.
+### local_production
 
-Рассмотрите гипотезу о том, что можно закешировать `<%= render "articles/single_story", story: story %>` в `_main_stories_feed.html.erb` и это даст заметный эффект.
+Cделать новый `environment`, `local_production`
 
-- Не забудьте включить локальное кэширование (`touch tmp/caching-dev.txt`)
-- Сделайте `benchmark` с помощью `ab`
-- Сделайте оптимизацию
-- Перезапустите `benchmark`
+Основное, что должно отличать ваш `local_production` от `development`:
 
-Если вы посчитаете, что применить кэширование здесь целесообразно, оформите обоснованный `PR` с этим предложением. Напишите в описании `PR`, какая была гипотеза, откуда она взялась, как вы проверяли гипотезу, какие результаты получили. Приложите скриншоты графиков мониторинга, если на них виден эффект оптимизации.
+- `cache_classes: true`
+- `eager_load: true`
+- `perform_caching: true`
+- `assets_debug: false`
+- `assets_compile: false`
 
-## Bonus
+Для работы потребуется прекомпиляция ассетов `rake assets:precompile`
 
-Поищите возможности для оптимизации самостоятельно. Если сможете что-то найти и оптимизировать, добавляйте в `PR` ваши оптимизации с обоснованиями.
 
 ## Сдача задания
 
-`PR` в этот репозиторий с кодом и подробным описанием проделанной работы в описании `PR`-а.
+Как обычно, `PR` в этот репозиторий с кодом и case-study по проделанной работе в описании `PR`-а, или в файле.
 
 <div align="center">
   <br>