Skip to content

Commit

Permalink
Merge pull request #3883 from werf/docs_fix_release_channels_usage
Browse files Browse the repository at this point in the history
docs: the only term for release channels
  • Loading branch information
alexey-igrychev committed Oct 25, 2021
2 parents ee54136 + 82ed87f commit 077cd28
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -104,7 +104,7 @@ werf is not a complete CI/CD solution, but a tool for creating pipelines that ca

## Production ready

werf is a mature, reliable tool you can trust. [Read about stability channels and release process](https://werf.io/installation.html#all-changes-in-werf-go-through-all-stability-channels).
werf is a mature, reliable tool you can trust. [Read about release channels](https://werf.io/installation.html#all-changes-in-werf-go-through-all-release-channels).


## Documentation
Expand Down
6 changes: 3 additions & 3 deletions docs/site/.werf/artifacts/feed-group-channel.xml-template
Expand Up @@ -14,8 +14,8 @@ sitemap_include: false
xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
>
<channel>
<title>Events on {{ group }} {{ channel }} werf update channel</title>
<description>werf version changes events on the update channel {{ group }} {{ channel }}.</description>
<title>Events on {{ group }} {{ channel }} werf release channel</title>
<description>werf version changes events on the release channel {{ group }} {{ channel }}.</description>
<sy:updatePeriod>daily</sy:updatePeriod>
<sy:updateFrequency>1</sy:updateFrequency>
<link>{{ site.url }}/releases.html</link>
Expand All @@ -24,7 +24,7 @@ sitemap_include: false
{%- for event in group_events limit:feed_items %}
{%- assign event_info = site.data.releases.releases | where: "tag_name", event.version | first %}
<item>
<title>{{ event.version }} on update channel {{ event.group }}/{{ event.name }}</title>
<title>{{ event.version }} on release channel {{ event.group }}/{{ event.name }}</title>
<description></description>
<pubDate>{{ event.ts | date_to_rfc822 }}</pubDate>
<link>{{ event_info.html_url }}</link>
Expand Down
2 changes: 1 addition & 1 deletion docs/site/_data/channels_info.yml
Expand Up @@ -6,7 +6,7 @@ channels:
en: These releases can bring new features, but are unstable. We do not guarantee backward compatibility between <b>Alpha</b> releases.
ru: Версии этого канала обновлений могут содержать новые возможности, а также быть нестабильными, иметь ошибки. Мы не гарантируем обратную совместимость между версиями канала обновлений <b>Alpha</b>.
tooltip:
en: Least stable update channel
en: Least stable release channel
ru: Наименее стабильный канал обновлений
- name: beta
stability: 1
Expand Down
2 changes: 1 addition & 1 deletion docs/site/backend/README.md
Expand Up @@ -11,7 +11,7 @@ Get status info (JSON).
- 'msg' — Empty if `status` is `ok`, otherwise contains text representation of the error.
- `rootVersion` — Version to show as main. E.g. - `v1.2.4+fix18`.
- `rootVersionURL` — URL location for RootVersion. E.g. - `v1.2.4-plus-fix18`.
- `multiwerf` — content of the used multiwerf.json (info about which versions belong to update channels)
- `multiwerf` — content of the used multiwerf.json (info about which versions belong to release channels)

Example:
```json
Expand Down
2 changes: 1 addition & 1 deletion docs/site/pages_en/feed.xml
Expand Up @@ -11,7 +11,7 @@ permalink: /feed.xml
>
<channel>
<title>Werf update events</title>
<description>Werf version changes events on any of the update channels.</description>
<description>Werf version changes events on any of the release channels.</description>
<sy:updatePeriod>daily</sy:updatePeriod>
<sy:updateFrequency>1</sy:updateFrequency>
<link>{{ site.url }}/releases.html</link>
Expand Down
4 changes: 2 additions & 2 deletions docs/site/pages_en/index.md
Expand Up @@ -271,8 +271,8 @@ sidebar: none
werf is a mature,<br>
reliable tool you can trust
</div>
<a href="{{ "installation.html#all-changes-in-werf-go-through-all-stability-channels" | true_relative_url }}" class="page__btn page__btn_b page__btn_small page__btn_inline">
Read about stability channels and release process
<a href="{{ "installation.html#all-changes-in-werf-go-through-all-release-channels" | true_relative_url }}" class="page__btn page__btn_b page__btn_small page__btn_inline">
Read about release channels
</a>
</div>
<div class="reliability__column reliability__column_image">
Expand Down
4 changes: 2 additions & 2 deletions docs/site/pages_en/installation.md
Expand Up @@ -203,9 +203,9 @@ arch:
</div>

<div class="installation-channels">
<h2 class="installation-channels__title" id="all-changes-in-werf-go-through-all-stability-channels">
<h2 class="installation-channels__title" id="all-changes-in-werf-go-through-all-release-channels">
All changes in werf<br>
go through all stability channels
go through all release channels
</h2>
<ul class="installation-channels__channels">
<li class="installation-channels__channel">
Expand Down
4 changes: 2 additions & 2 deletions docs/site/pages_ru/index.md
Expand Up @@ -283,8 +283,8 @@ sidebar: none
werf — это зрелый, надежный<br>
инструмент, которому можно доверять
</div>
<a href="{{ "installation.html#все-изменения-в-werf-проходят-через-цепочку-каналов-стабильности" | true_relative_url }}" class="page__btn page__btn_b page__btn_small page__btn_inline">
Подробнее об уровнях стабильности и релизах
<a href="{{ "installation.html#все-изменения-в-werf-проходят-через-цепочку-каналов-обновлений" | true_relative_url }}" class="page__btn page__btn_b page__btn_small page__btn_inline">
Подробнее о каналах обновлений
</a>
</div>
<div class="reliability__column reliability__column_image">
Expand Down
14 changes: 7 additions & 7 deletions docs/site/pages_ru/installation.md
Expand Up @@ -39,7 +39,7 @@ arch:
</div>
</div><!-- /selector -->
<div class="installation-selector">
<div class="installation-selector__title">Канал стабильности</div>
<div class="installation-selector__title">Канал обновлений</div>
<div class="tabs tabs_simple_condensed">
<a href="javascript:void(0)" class="tabs__btn"
data-install-tab-group="channel" data-install-tab="rock-solid">Rock-Solid</a>
Expand Down Expand Up @@ -203,9 +203,9 @@ arch:
</div>

<div class="installation-channels">
<h2 class="installation-channels__title" id="все-изменения-в-werf-проходят-через-цепочку-каналов-стабильности">
<h2 class="installation-channels__title" id="все-изменения-в-werf-проходят-через-цепочку-каналов-обновлений">
Все изменения в werf<br>
проходят через цепочку каналов стабильности
проходят через цепочку каналов обновлений
</h2>
<ul class="installation-channels__channels">
<li class="installation-channels__channel">
Expand Down Expand Up @@ -261,12 +261,12 @@ arch:
</ul>
<div class="installation-channels__info">
<div class="installation-channels__info-versions">
<p>При использовании каналов стабильности не требуется указывать конкретную версию, т.к. конкретную версию активирует trdl, выступая в роли менеджера версий. Это позволяет автоматически и непрерывно получать как исправления проблем, так и новые возможности, оперативно откатывать проблемные изменения. В целом такая схема даёт баланс между достаточно высоким уровнем стабильности софта и быстрой разработкой новых возможностей.</p>
<p>Связи между каналом стабильности и конкретной версией werf описываются в специально файле <a href="https://raw.githubusercontent.com/werf/werf/multiwerf/trdl_channels.yaml">trdl_channels.yaml</a>.</p>
<p>При использовании каналов обновлений не требуется указывать конкретную версию, т.к. конкретную версию активирует trdl, выступая в роли менеджера версий. Это позволяет автоматически и непрерывно получать как исправления проблем, так и новые возможности, оперативно откатывать проблемные изменения. В целом такая схема даёт баланс между достаточно высоким уровнем стабильности софта и быстрой разработкой новых возможностей.</p>
<p>Связи между каналом обновлений и конкретной версией werf описываются в специальном файле <a href="https://raw.githubusercontent.com/werf/werf/multiwerf/trdl_channels.yaml">trdl_channels.yaml</a>.</p>
</div>
<div class="installation-channels__info-guarantees">
<div class="installation-channels__info-guarantee">
<strong>Мы гарантируем</strong>, что релиз из канал <i>Early-Access</i> попадёт в канал <i>Stable</i> не раньше, чем через 1 неделю после внутреннего тестирования.
<strong>Мы гарантируем</strong>, что релиз из канала <i>Early-Access</i> попадёт в канал <i>Stable</i> не раньше, чем через 1 неделю после внутреннего тестирования.
</div>
<div class="installation-channels__info-guarantee">
<strong>Мы гарантируем</strong>, что релиз из канала <i>Stable</i> должен попасть в канал <i>Rock-Solid</i> не раньше, чем через 2 недели активного тестирования.
Expand Down Expand Up @@ -298,7 +298,7 @@ arch:
{%- for group in groups %}
<div id="group-{{group}}" class="tabs__content tabs__content_simple tabs__group__content{% if group == groups[0] %} active{% endif %}">
<div class="installation-releases__block-subtitle">
Уровень стабильности
Канал обновлений
</div>
<div class="tabs tabs_simple_condensed">
{%- assign not_activated = true %}
Expand Down

0 comments on commit 077cd28

Please sign in to comment.