Актуализация и мелочи

Dockerfile

@@ -1,10 +1,10 @@
-FROM squidfunk/mkdocs-material AS m3u-su-docs-builder
+FROM squidfunk/mkdocs-material AS builder
 COPY . /docs
 RUN mkdocs build
 
-FROM nginx:alpine AS m3u-su-docs
+FROM nginx:alpine AS iptv-docs
 LABEL org.opencontainers.image.authors="Anthony Axenov <anthonyaxenov@gmail.com>"
-COPY --from=m3u-su-docs-builder /docs/site /usr/share/nginx/html
+COPY --from=builder /docs/site /usr/share/nginx/html
 WORKDIR /usr/share/nginx/html
 USER root
 EXPOSE 80

Makefile

@@ -8,11 +8,11 @@ live:
 		--tty \
 		--publish 3000:8000 \
 		--volume ${PWD}:/docs \
-		--name m3u-su-docs-builder \
+		--name iptv-docs-dev \
 		squidfunk/mkdocs-material:9.6.20
 
 ## image: Build local static site
-build:
+site:
 	@echo "Wait until mkdocs finish"
 	@docker run \
 		--pull always \
@@ -20,19 +20,19 @@ build:
 		--interactive \
 		--tty \
 		--volume ${PWD}:/docs \
-		--name m3u-su-docs-builder \
+		--name iptv-docs-dev \
 		squidfunk/mkdocs-material:9.6.20 build
 
 ## image: Build docker image
 image:
 	@docker build \
-		--tag m3u-su-docs:latest \
+		--tag iptv-docs:latest \
-		--tag git.axenov.dev/iptv/m3u-su-docs:latest \
+		--tag git.axenov.dev/iptv/iptv-docs:latest \
 		.
 
 ## push: Push docker image to registry
 push:
-	@docker push git.axenov.dev/iptv/m3u-su-docs:latest
+	@docker push git.axenov.dev/iptv/iptv-docs:latest
 
 ## run: Run docker image (localhost:3001)
 run:
@@ -40,8 +40,8 @@ run:
 	@docker run \
 		--rm \
 		--publish 3001:80 \
-		--name m3u-su-docs \
+		--name iptv-docs \
-		git.axenov.dev/iptv/m3u-su-docs:latest
+		git.axenov.dev/iptv/iptv-docs:latest
 
 ## help: Show this message and exit
 help: Makefile

mkdocs.yml

@@ -125,6 +125,7 @@ nav:
       - iptvc/commands/help.md
       - iptvc/commands/check.md
       - iptvc/commands/version.md
+  - statuspage.md
   - 'Для разработчиков':
     - dev/index.md
     - dev/local-dev.md

src/common/connect.md

@@ -8,7 +8,7 @@ tags: ["плееры", "плейлисты"]
 1. Найти какой-нибудь [плеер](./players.md)
 2. Узнать как в него добавить плейлист по ссылке
 3. Найти желаемый плелист из [списка](./list.md)
-4. Найти на странице ["Ссылку для ТВ"](details.md#ссылка-для-тв) и ввести (скопировать) её в поле ввода адреса в плеере
+4. Найти на странице ["Ссылку для ТВ"](details.md#shortlink) и ввести (скопировать) её в поле ввода адреса в плеере
 
 Для некоторых [плееров](./players.md) уже есть информация как добавить плейлист.
 

src/common/details.md

@@ -59,17 +59,13 @@ tags: ["сайт", "статусы", "каналы"]
 
 ## Список каналов
 
-![Cписок каналов](../assets/img/pls-details/ch-list.jpg)
-
 В заголовке пишется их общее количество.
 
-Если общее количество каналов 500 и более, то под заголовком отобразится подсказка, чтобы ты не убегал раньше времени.
+![Cписок каналов](../assets/img/pls-details/ch-list.jpg)
-Надо просто подождать несколько секунд, список догрузится и подсказка исчезнет.
 
-??? quote "Скриншот подсказки"
+В списке всегда отображается не более 100 каналов.
-    !!! success "Да, это недоработка, подпёртая костылём, но это беспокоит меня меньше всего."
+
-        Может быть когда-нибудь сделаю лучше. Или нет.
+Воспользуйтесь поиском, чтобы найти интересующий.
-    ![Скриншот подсказки над списком каналов](../assets/img/pls-details/hint.jpg)
 
 ### Поиск каналов
 
@@ -98,7 +94,7 @@ tags: ["сайт", "статусы", "каналы"]
 ??? quote "Пример фильтрации"
     ![Скриншот используемого фильтра списка каналов](../assets/img/pls-details/filter.jpg)
 
-<a id="ссылка-для-тв"></a>
+<a id="shortlink"></a>
 ## Ссылка для ТВ
 
 Она может быть задана в нескольких форматах.

src/common/list.md

@@ -29,7 +29,7 @@ tags: ["сайт", "плейлисты"]
         * [список тегов](../formats/channels.md#доступные-теги), собранный со всех каналов после их проверки (только при статусе <span class="badge online">online</span>)
         * ещё одна ссылка на [страницу плейлиста](../common/details.md)
 * **Каналов** — фактическое количество каналов в плейлисте (только при статусе <span class="badge online">online</span>) или 0 (при других статусах)
-* **Ссылка для ТВ** — [короткая ссылка](details.md#ссылка-для-тв), которую можно использовать для [подключения плейлиста](../common/connect.md).
+* **Ссылка для ТВ** — [короткая ссылка](details.md#shortlink), которую можно использовать для [подключения плейлиста](../common/connect.md).
 
 В зависимости от ширины экрана, для экономии места может быть скрыто описание с иконками возможностей и короткая ссылка.
 

src/dev/docs.md

@@ -81,7 +81,7 @@ make live
 ## Генерация статического сайта
 
 ```
-make build
+make site
 ```
 
 Генерирует статические файлы, которую можно версионировать, хранить,деплоить отдельно или просматривать на ПК через браузер.
@@ -96,7 +96,7 @@ make image
 
 Собирает docker-образ на основе nginx, генерируя перед этим статический сайт.
 
-Запустить контейнер из этого образа можно командой:
+Запустить контейнер из этого образа по адресу [localhost:3001](http://localhost:3001) можно командой:
 
 ```
 make run

src/docs.md

@@ -2,11 +2,10 @@
 icon: material/book-open-page-variant-outline
 ---
 
-# :material-book-open-page-variant-outline: Работа с документацией
+# :material-book-open-page-variant-outline: Об этой документации
 
-!!! warning "Актуальность"
+!!! warning "Актуальность документации может отставать от текущей версии сервиса, его исходных кодов и инфраструктуры"
-    Она может отставать от актуальной версии сервиса, его исходных кодов и инфраструктуры.
+    Поддерживать содержимое в актуальном состоянии большой труд.
-    Поддерживать документацию в актуальном состоянии — тоже труд.
     Прошу отнестись с пониманием, а лучше — [помочь делом](support.md#participate).  
 
 !!! danger "Тем не менее, прошу прочесть её!"

src/faq.md

@@ -121,7 +121,7 @@ tags: ["сайт", "каналы", "плейлисты", "epg", "плееры",
 
 Что значит "не работает"?
 
-* Ты уверен, что ссылка в [правильном формате](common/details.md#ссылка-для-тв)?
+* Ты уверен, что ссылка в [правильном формате](common/details.md#shortlink)?
 * Ты уверен, что у тебя нормальное интернет-соединение?
 * Плеер показывает какую-то ошибку при добавлении плейлиста?
 * Плейлист добавляется по ссылке, но каналы не загружаются или плеер зависает?

src/statuspage.md

@@ -0,0 +1,29 @@
+---
+icon: material/pulse
+tags: ["сайт"]
+---
+
+# :material-pulse: Статус сервиса
+
+Так выглядит статусная страница сервиса.
+Попасть на неё можно по ссылке "[Аптайм](https://status.m3u.su)" в шапке сайта.
+
+![Скриншот с примером главной страницы на десктопе](../assets/img/status/main.jpg)
+
+Здесь отображается состояние компонентов сервиса:
+
+* веб-интерфейс (то, что открывается в браузере);
+* чекер (фоновая проверка плейлистов с помощью [iptvc](iptvc/index.md));
+* кэш (база данных с временными данными о результатах проверки плейлистов).
+
+Шкалы движутся во времени справа налево.
+Они должны быть зелёными, а статус компонента должен быть «Healthy».
+Каждое деление на шкале приблизительно равно 10 минутам между проверками.
+
+Можно нажать на незвание сервиса и посмотреть детальную информацию:
+
+![Скриншот с примером страницы компонента на десктопе](../assets/img/status/details.jpg)
+
+Если на шкале появляется красное деление, значит был кратковременный сбой.
+
+Но если вместо зелёного преобладают красные цвета, значит на сервере что-то основательно сломалось.