[docs] Update module documentation style and error handling#225
Draft
dbalaban-iwl wants to merge 7 commits into
Draft
[docs] Update module documentation style and error handling#225dbalaban-iwl wants to merge 7 commits into
dbalaban-iwl wants to merge 7 commits into
Conversation
- Переименовал русский FAQ по конвенции Hugo - README сделал обзорным: назначение, возможности и ограничения, без пошагового включения модуля - Быстрый старт вынес в примеры — включение модуля, создание StorageClass и проверка работоспособности, плюс прежние примеры с TLS - В README добавил отдельные ссылки на быстрый старт, примеры и FAQ - Описание очистки тома перенёс в FAQ - Команды заменил на d8 k, у блоков кода указал язык, ссылки сделал без домена - Подправил терминологию и формулировки - У страниц CR и CONFIGURATION убрал ручной description, в CR поправил title и имя ресурса - Предупреждения в виде цитат заменил на Hugo-алерты - Внёс мелкие правки заголовков и метаданных Signed-off-by: Dmitry Balaban <dmitry.balaban@flant.com>
dbalaban-iwl
changed the title
…ucture Signed-off-by: Dmitry Balaban <dmitry.balaban@flant.com>
Signed-off-by: Max Chervov <max.chervov@gmail.com>
…, restored Quickstart, and fixed introductions and links. Moved the RED OS NFS setup to EXAMPLES.ru and removed the English RED OS section. Signed-off-by: Dmitry Balaban <dmitry.balaban@flant.com>
Signed-off-by: Max Chervov <max.chervov@gmail.com>
maxinsky
previously approved these changes
Jul 23, 2026
z9r5
reviewed
Jul 24, 2026
| Установка зависимостей: | ||
|
|
||
| ```shell | ||
| # dnf install automake gcc gnutls-devel keyutils-libs-devel libnl3-devel glib2-devel wget |
Member
There was a problem hiding this comment.
Suggested change
| # dnf install automake gcc gnutls-devel keyutils-libs-devel libnl3-devel glib2-devel wget | |
| dnf install automake gcc gnutls-devel keyutils-libs-devel libnl3-devel glib2-devel wget |
z9r5
reviewed
Jul 24, 2026
| Установите зависимости: | ||
|
|
||
| ```shell | ||
| # dnf install libxml2-devel rpcgen libtirpc-devel libuuid-devel libevent-devel sqlite-devel device-mapper-devel sssd-krb5-common krb5-devel gssproxy libev libnfsidmap libverto-libev quota quota-nls rpcbind sssd-nfs-idmap |
Member
There was a problem hiding this comment.
Suggested change
| # dnf install libxml2-devel rpcgen libtirpc-devel libuuid-devel libevent-devel sqlite-devel device-mapper-devel sssd-krb5-common krb5-devel gssproxy libev libnfsidmap libverto-libev quota quota-nls rpcbind sssd-nfs-idmap | |
| dnf install libxml2-devel rpcgen libtirpc-devel libuuid-devel libevent-devel sqlite-devel device-mapper-devel sssd-krb5-common krb5-devel gssproxy libev libnfsidmap libverto-libev quota quota-nls rpcbind sssd-nfs-idmap |
z9r5
reviewed
Jul 24, 2026
|
|
||
| В логах tlshd будет информация об успешном подключении к NFS-серверу | ||
|
|
||
| ```shell |
Member
There was a problem hiding this comment.
Suggested change
| ```shell | |
| ```console |
z9r5
reviewed
Jul 24, 2026
Comment on lines
+123
to
+133
| - Для двух CA: | ||
|
|
||
| ```shell | ||
| cat CA1.crt CA2.crt | base64 -w0 | ||
| ``` | ||
|
|
||
| - Для трех CA: | ||
|
|
||
| ```shell | ||
| cat CA1.crt CA2.crt CA3.crt | base64 -w0 | ||
| ``` |
…lit long commands and outputs, unify relative paths in links Signed-off-by: Dmitry Balaban <dmitry.balaban@flant.com>
Signed-off-by: Dmitry Balaban <dmitry.balaban@flant.com>
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
3 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.
Description
Renamed Russian FAQ following Hugo conventions. Made README overview with purpose, features and limitations. Moved quick start to examples. Added separate links to quick start, examples and FAQ in README. Moved volume cleanup description to FAQ.
Why do we need it, and what problem does it solve?
Why do we need it in the patch release (if we do)?
Checklist
Changelog entries