docs: add rules for device teardown and README structure - #11
Open
Onlysudden wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Что происходит; кому и зачем нужно:
Оба правила выросли из ревью wb-mqtt-waterius. Там разбирались, кто снимает виртуальные устройства при остановке сервиса, и отдельно - с чего должен начинаться README сервиса. Ответы годятся любому сервису WB, поэтому переезжают в шаблон.
Что сделано и почему.
Добавлен пункт «Виртуальные устройства снимает сам сервис» в разделе «Сервис», следом за перехватом сигналов. Устройства опубликованы с
retain, поэтому после остановки сервиса они остаются на брокере, и затереть их топики может только он сам. Снятие ставится на штатный путь остановки, а не вfinally, потому что при падении устройства должны остаться и показывать ошибку через Last Will.Добавлен подраздел «README» перед «Пакетированием». README сервиса начинается с одного-двух предложений о том, что это за сервис, и раздела «Зачем это нужно», где каждый пункт - снятая с человека проблема, а не строка из перечня функций.
Что поменялось для пользователей:
Автор нового сервиса находит в шаблоне два правила, которых там не было - кто и когда снимает виртуальные устройства и с чего начинается README.
Код и упаковка шаблона не тронуты.
Как проверял/а:
Правки текстовые, кода не касаются.