Added english translation and replaced broken textmate link with a working alternative

[Awesome158]

No description provided.

[gretmn102]

Есть ли смысл дублировать title в front metter, когда заголовки уже присутствует в теле статьи?

В случае изменения заголовка придется менять их в двух местах. Предлагаю убрать title, либо убрать заголовок в самих статьях, если в title есть какие-либо весомые основания.

markdownlint, например, подчеркивает это как предупреждение:

If YAML front matter is present and contains a title property (commonly used with blog posts), this rule treats that as a top level heading and will report a violation for any subsequent top-level headings.
https://github.com/DavidAnson/markdownlint/blob/v0.27.0/doc/md025.md

[Awesome158]

Я удалил заголовочную часть (front matter) во всех файлах, кроме qsp-keywords.
Также удалил файл _category_yml, так как он мешал добавить английский заголовок.

[gretmn102]

удалил файл _category_yml, так как он мешал добавить английский заголовок

@Awesome158, возможно, из-за наличия label:

qspfoundation.github.io/docs/language/qsp-keywords/_category_.yml

Line 2 in 59dd001

label: Зарезервированные слова, системные переменные, спецсимволы

Ну, я так понимаю, что файл все равно не шибко критичен, потому что:

• задает title

  В подпапке уже есть index.md, в котором можно задать заголовок (что, собственно, ты и сделал). Но я бы советовал задавать заголовок через #, потому что так задано в других статьях, таким образом держим общую стилистику

• задает position

  В принципе, не критичный параметр, потому категория тут одна единственная, так что ¯\_(ツ)_/¯. Возможно, в index.md в случае чего можно задать position во front metter, но я с этим делом не экспериментировал 🤔

[gretmn102]

@Awesome158, спрошу еще по поводу id. Признаться честно, не очень понимаю, зачем они нужны. Docusaurus их генерирует автоматически из пути, так что они повторяют примерно ту же историю, что и дублирование заголовков в title во front matter и в самом теле статьи.

Например, кто-то исправит ошибку в названии qsp-keyword-operacion.md и переименует его в qsp-keyword-operation.md, тогда придется исправлять id во front metter статьи. Лишняя работа.

Если это как-то критично связано с системой переводов статей в Docusaurus, то вопросов нет 👻

[Awesome158]

Да, вы правы — id во front matter не нужен, уберу его. Я не особо шарю в Docusaurus, поэтому думал, что он обязателен, но проверил — без него всё нормально работает :)
Хотя, на мой взгляд, проще было бы, если что, поправить сам id, а имя файла не трогать — но тут уже как решите.
А вот title в qsp_keyword всё же нужен, потому что сейчас там вверху видно «Index», а не «Зарезервированные слова, системные переменные, спецсимволы». То есть title во front matter по сути выполняет ту же роль, что и _category_.yml.

[gretmn102]

title в qsp_keyword всё же нужен, потому что сейчас там вверху видно «Index», а не «Зарезервированные слова, системные переменные, спецсимволы». То есть title во front matter по сути выполняет ту же роль, что и category.yml

@Awesome158, хм, буду знать. Docusaurus для меня сам еще загадка, особенно, после такого 😓

[gretmn102]

@Awesome158, что ж, похоже, всё в порядке. Остался последний штрих — почистить историю ветки, чтобы я смог с помощью git rebase main слить все коммиты в main ветку. Знаю, утомил, но иначе история хранилища превратится в бардак. Заодно потренируешься изменять историю хранилища (полезный опыт, ящитаю). Впрочем, если надоело, то отпишись — сам почищу 👻

Предлагаю следующий список коммитов:

docs(syntax-highlighting): replace broken link with a working alternative (#33)

Это тот коммит, который ты сделал, но предлагаю сделать его в самом начале, чтобы он был отдельно от перевода на английский.

По поводу описания коммита:

• Я выбрал docs в качестве тега коммита заместо fix, потому что fix чинит работоспособность проекта и его соответствие ожиданиям (что бы это не значило). А эти изменения — всего лишь обновление протухших внешних ссылок, без которых, в общем-то и так всё работает
• Указание syntax-highlighting нам точно скажет, где именно починили ссылки, потому что их полным полно во всем репозитории 👻
• Коммит советуют описывать в повелительном наклонении, поэтому replaced заменил на replace
• (#33) — указание на данный пулл реквест. Поскольку мы мерджим пулл реквесты через rebase, то все коммиты попадают в главную ветку как есть. А как их связать с данным пулл реквестом? Вот таким образом

docs: remove language/qsp-keywords/_category_.yml (#33)

Изменения в:

• docs/language/qsp-keywords/_category_.yml
• docs/language/qsp-keywords/index.md

styles(docs): trim trailing whitespaces (#33)

В этом коммите убираются только пробелы, как ты сделал в docs/language/qsp-keywords/qsp-keyword-operacion.md и в прочих файлов

feat: prepare docusaurus for internationalization (#33)

Изменения, связанные с docusaurus.config.ts.

Полное описание коммита должно быть таким:

feat: prepare docusaurus for internationalization (#33)

Closes: #23

Строчкой Closes: #23 мы показываем, что закрываем #23 issue. GitHub это делает автоматически, что довольно удобно. Короче, сам всё увидишь, когда сольем коммиты в основную ветку.

docs: add English translation (#33)

Ну, и наконец самый главный коммит, ради которого всё и затевалось.

[Awesome158]

@gretmn102
Могу я просто создать новый форк, всё переделать и отправить новый pull request? Думаю, так будет проще.