Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
285 changes: 285 additions & 0 deletions 000_template/README_RU.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,285 @@
# Руководство по стилю

Используйте этот файл в качестве руководства по стилю при создании новых документов cue-by-example, и
используйте файл [template.md](template.md) в качестве шаблона, который можно копировать и адаптировать.

## Соглашения

### Заголовки разделов

Используйте один заголовок H1 (`#`) вверху, чтобы обозначить название документа.

В строке Markdown непосредственно под строкой H1 включите элемент HTML `<sup>`,
содержащий ваше предпочтительное указание авторства документа и для каждого соавтора.
Например:

---

```
# Использование CUE для продвижения в Голливуде
<sup>от [Джорджа Клуни](https://www.imdb.com/name/nm0000123/)</sup>
<sup>и [Хэлли Берри](https://www.imdb.com/name/nm0000932/)</sup>
```

---

... который отображается как:

---

# Использование CUE для продвижения в Голливуде
<sup>от [Джорджа Клуни](https://www.imdb.com/name/nm0000123/)</sup>
<sup>и [Хэлли Берри](https://www.imdb.com/name/nm0000932/)</sup>

---

Используйте заголовки H2 (`##`) для разделения изолированных, самостоятельных сценариев.

Используйте заголовки H3 (`###`) для обозначения разделов внутри одного сценария.

Используйте заголовки H4 (`####`) для именования отдельных шагов в разделе. Это позволит
пользователям ссылаться на шаг, что будет полезно, если пользователь застрял и
нуждается в помощи в CUE Slack, чтобы определить, на каком шаге он застрял.

В строке H4 добавьте префикс к названию каждого шага, который пользователь должен выполнить,
иконкой :arrow_right: (`:arrow_right:`).

Например:

---

```
#### :arrow_right: Обработать doodahs

Обработка doodahs удаленно проста, если вы помните, что нужно очистить widgets.
Чтобы сделать это, ...
```

---

... который отображается как:

---

#### :arrow_right: Обработать doodahs

Обработка doodahs удаленно проста, если вы помните, что нужно очистить widgets.
Чтобы сделать это, ...

---

Пожалуйста, включите как минимум:

- вводный раздел, охватывающий **по крайней мере** предварительные требования, которые читатель
должен знать, чтобы успешно использовать документ
- раздел с шагами, которые нужно выполнить, с маркерами шагов, как описано выше
- заключительный раздел

### Файлы

Обозначьте каждый файл, который пользователь должен создать:

- иконкой :floppy_disk: (`:floppy_disk:`)
- за которой в той же строке следует путь и имя файла в блоке встроенного кода
- за которым следует блок кода с преамбулой типа содержимого, содержащий
содержимое файла.

Например:

---

```` # здесь четыре обратных апострофа *только* чтобы позволить трем апострофам ниже отображаться
:floppy_disk: `some_file.cue`
```CUE
package cbe123

some_content: "some string"
```
````

---

... который отображается как:

---

:floppy_disk: `some_file.cue`
```CUE
package cbe123

some_content: "some string"
```

---

### Блоки команд оболочки

Обозначьте одну или несколько команд, которые пользователь должен выполнить в оболочке:

- иконкой :computer: (`:computer:`)
- за которой в той же строке следует слово `terminal` в блоке встроенного кода
- за которым следует блок кода с типом содержимого `sh`
- с каждой командой, которую пользователь должен выполнить, на отдельной строке, без **никакого префикса**
- с любыми критическими комментариями после связанной команды, разделенными
подходящим символом комментария оболочки (обычно `#`).

Отсутствие префикса означает, что при использовании кнопки "копировать", которую GitHub
автоматически размещает в правом верхнем углу каждого блока кода, читателю будет предоставлен
полезный текст для вставки. Если бы вы включили префикс, например `$`, то
читатель не смог бы вставить команды непосредственно в терминал.

Включите пример вывода в отдельном блоке кода после блока команд,
чтобы помочь пользователю оценить, выполнилась ли команда должным образом на его локальной машине.

Например:

---

```` # здесь четыре обратных апострофа *только* чтобы позволить трем апострофам ниже отображаться
:computer: `terminal`
```sh
echo "hello world" | tr 'a-z' 'A-Z' | tr -s 'A-Z' # это действительно важная команда
echo 'CUE это круто!'
```

Ожидаемый вывод:
```
HELO WORLD
CUE это круто!
```
````

---

... который отображается как:

---

:computer: `terminal`
```sh
echo "hello world" | tr 'a-z' 'A-Z' | tr -s 'A-Z' # это действительно важная команда
echo 'CUE это круто!'
```

Ожидаемый вывод:
```
HELO WORLD
CUE это круто!
```

---

#### Сворачивание длинного содержимого файлов или оболочки

Когда содержимое файла или блока оболочки достаточно длинное и нарушает поток
руководства, рассмотрите возможность размещения длинного содержимого внутри элемента HTML
`<details>` с возможностью "раскрытия кликом".

Этот элемент имеет 2 части:

- короткую преамбулу, которая всегда видна (элемент `<summary>`)
- свернутое содержимое, которое становится видимым только после клика

Пожалуйста, используйте элемент сворачивания следующим образом:

- Разместите элемент внутри пары горизонтальных линий (`<hr>`), чтобы обозначить для
читателя, где заканчивается развернутое содержимое
- Оберните имя файла в элемент `<code>` (вместо одинарных обратных апострофов)
- После имени файла добавьте слова `(нажмите, чтобы открыть)`
- Поместите пустую строку (в исходном коде) между закрывающим тегом `</summary>` и
началом блока кода файла (<code>```</code>), чтобы форматирование markdown GitHub
работало корректно

Вот пример использования элемента `<details>` для сворачивания файла:

````

Здесь файл, который может быть вам полезен:

<hr>
<details>
<summary>
:floppy_disk: <code>a_file.cue</code> (нажмите, чтобы открыть)
</summary>

```text
Д
лин
ный
файл
но
не
на
са
мо
го
дел
просто
при
мер
```
</details>
<hr>
````

Это отображается следующим образом:

Здесь файл, который может быть вам полезен:

<hr>
<details>
<summary>
:floppy_disk: <code>a_file.cue</code> (нажмите, чтобы открыть)
</summary>

```text
Д
лин
ный
файл
но
не
на
са
мо
го
дел
просто
при
мер
```
</details>
<hr>

### Блоки предупреждений и информации

Если вашему читателю нужно предупредить или проинформировать в определенной точке
документа, используйте таблицу Markdown, как в следующем примере, с одним из
заголовков точно так, как указано:

---

```
| :exclamation: ПРЕДУПРЕЖДЕНИЕ :exclamation: |
|:------------------------------------------ |
| Этот текст предупреждения должен находиться на одной строке в исходном коде markdown, так как при наличии разрыва строки форматирование нарушится. Хотя это может привести к громоздкому исходному тексту, отрендеренный результат выглядит нормально. Чтобы принудительно сделать разрыв строки, используйте HTML-тег `<br>`, например так:<br> Чтобы принудительно сделать пустую строку, используйте два, например так:<br><br> Эта строка исходного кода, в отличие от двух выше, **не** нуждается в завершающем символе вертикальной черты. Большинство элементов форматирования markdown работают корректно в таблицах, таких как [ссылки](https://example.com), *курсив*, **жирный**, и `встроенные блоки кода`. Что-либо с несколькими строками, например блоки кода, вероятно, не будет работать.

| :grey_exclamation: Информация :grey_exclamation: |
|:----------------------------------------------- |
| Этот информационный блок менее "громкий", чем ПРЕДУПРЕЖДЕНИЕ выше. Все примечания по форматированию и содержанию из примера ПРЕДУПРЕЖДЕНИЯ также применимы здесь.
```

---

Это отображается следующим образом:

---

| :exclamation: ПРЕДУПРЕЖДЕНИЕ :exclamation: |
|:------------------------------------------ |
| Этот текст предупреждения должен находиться на одной строке в исходном коде markdown, так как при наличии разрыва строки форматирование нарушится. Хотя это может привести к громоздкому исходному тексту, отрендеренный результат выглядит нормально. Чтобы принудительно сделать разрыв строки, используйте HTML-тег `<br>`, например так:<br> Чтобы принудительно сделать пустую строку, используйте два, например так:<br><br> Эта строка исходного кода, в отличие от двух выше, **не** нуждается в завершающем символе вертикальной черты. Большинство элементов форматирования markdown работают корректно в таблицах, таких как [ссылки](https://example.com), *курсив*, **жирный**, и `встроенные блоки кода`. Что-либо с несколькими строками, например блоки кода, вероятно, не будет работать.

| :grey_exclamation: Информация :grey_exclamation: |
|:----------------------------------------------- |
| Этот информационный блок менее "громкий", чем ПРЕДУПРЕЖДЕНИЕ выше. Все примечания по форматированию и содержанию из примера ПРЕДУПРЕЖДЕНИЯ также применимы здесь.
---
Loading