docs: update publish-s3 page and add publish section to settings (ru/en) - #300
Open
kazu-li wants to merge 1 commit into
Open
docs: update publish-s3 page and add publish section to settings (ru/en)#300kazu-li wants to merge 1 commit into
kazu-li wants to merge 1 commit into
Conversation
bloodmike
reviewed
Jul 13, 2026
| --- | --- | --- | ||
| `endpoint` | Эндпоинт для хранилища S3. | `https://s3.amazonaws.com` | ||
| `bucket` | Бакет. | — | ||
| `prefix` | Префикс для путей файлов.<br><br>Необязательный параметр. Может использоваться для передачи версии сборки, тогда каждая сборка будет складываться в отдельную папку. | — |
Collaborator
There was a problem hiding this comment.
переделай таблицу в многострочную и убери <br><br> - не будем подавать плохой пример в своей доке
|
|
||
| ```yaml | ||
| publish: | ||
| endpoint: "https://s3.example.com" |
Collaborator
There was a problem hiding this comment.
а тут точно один пробел нужен, а не больше?
| Параметр | Описание | Значение по умолчанию | ||
| --- | --- | --- | ||
| `endpoint` | Эндпоинт для хранилища S3. | `https://s3.amazonaws.com` | ||
| `bucket` | Бакет. | — |
Collaborator
There was a problem hiding this comment.
Спасибо, кэп :-)
хотя бы "название бакета"
| Команда publish только заливает файлы на S3, а не собирает документацию. Если вы хотите загружать на S3 уже готовую статику, то сначала нужно собрать документацию: | ||
|
|
||
| ```bash | ||
| yfm -i docs/ -o docs-html/ |
Collaborator
There was a problem hiding this comment.
давай тут в примере вызова явно укажем yfm build
|
|
||
| {% endnote %} | ||
|
|
||
| ### Секция `publish` {#publish} |
Collaborator
There was a problem hiding this comment.
вот это лишнее: этот файл посвящен параметрам yfm build, а не всем параметрам всех действий yfm подряд
✅ Documentation buildRevision built successfully |
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.
При настройке публикации документации на S3 обнаружил, что страница описывала устаревшие параметры (storageEndpoint, storageKeyId и т.д.) вместо актуального синтаксиса секции publish, а в доке настроек секция publish отсутствовала полностью.