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

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

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

src/statuspage.md

@@ -16,12 +16,13 @@ tags: ["сайт"]
 * чекер (фоновая проверка плейлистов с помощью [iptvc](iptvc/index.md));
 * кэш (база данных с временными данными о результатах проверки плейлистов).
 
-Зелёные шкалы движутся во времени справа налево и приблизительно равны последним двум часам проверок.
+Шкалы движутся во времени справа налево.
+Они должны быть зелёными, а статус компонента должен быть «Healthy».
 Каждое деление на шкале приблизительно равно 10 минутам между проверками.
 
-Можно нажать на сервис и посмотреть детальную информацию:
+Можно нажать на незвание сервиса и посмотреть детальную информацию:
 
-![Скриншот с примером страницы сервиса на десктопе](../assets/img/status/details.jpg)
+![Скриншот с примером страницы компонента на десктопе](../assets/img/status/details.jpg)
 
 Если на шкале появляется красное деление, значит был кратковременный сбой.