YAML-шапка статей

[furtivite]

У нас есть техническая информация, которая хранится в YAML-формате в шапке статей.

Она описана в примерах для статьи и для доки (кажется, тут можно оставить один файл).

Выглядит примерно так:

---
title: "Название статьи"
authors:
  - Никнейм основного автора
contributors:
  - Никнеймы всех соавторов и контрибьюторов
designers: Никнейм дизайнера
summary:
  - Альтернативные теги для работы поиска
cover:
  desktop: 'images/desktop.png'
  mobile: 'images/mobile.png'
  alt: 'Альтернативное описание для обложки'
tags:
  - doka
---

На техническом созвоне 16 июля мы договорились:

• Что нужно определиться в порядке таких полей, потому что автоматически это проверять невозможно
• Что нужно понять какие поля нам могут понадобиться дополнительно
• Что нужно поле типа starred или featured - чтобы выводить статью на главную

И раньше мы договорились, что поле summary будет переименовано в techs или что-то вроде того.

После обсуждения все поля надо будет привести к единому формату в #1056

[furtivite]

@pepelsbey, @tachisis, @solarrust, @nlopin, @igsekor, @monochromer приглашаются к обсуждению.

[furtivite]

Мне кажется, что большие поля-списки типа: ex-summary и tags — должны находиться где-то в конце списка, чтобы их править было удобнее.

[tachisis]

У меня особого мнения нет, как решите, так и ладно. Редакторский тег я обычно ставлю после всех авторов и контрибьюторов, так принято в книжном деле.

[igsekor]

Насколько я помню, мы договорились переименовать summary в keywords.

Последовательность полей, наверное, должна определяться редакторами из соображений безопасности удобства.

Мне со своей колокольни кажется логичным разделить поля на две группы: служебные и контентные (SEO?). Можно сделать примерно так:

• title
• description
• keywords
• tags
• cover
• authors
• contributors

Кажется, что в мете ещё должно появиться поле description для SEO.

[pepelsbey]

Я бы начал с тех полей, которые мы реально используем сейчас и определился с порядком:

title: 'Название статьи'
description: 'Описание статьи'
authors
  - author
contributors
  - contributor
editors
  - editor
keywords
  - слово
cover: 'Описание обложки'

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

• Что есть обложка
• Что у неё есть описание
• Что путь к обложке стандартные cover/desktop.png и cover/mobile.png

Всё это поможет разгрузить шапку от лишнего. Плюс это работает похоже на поле author: мы же не пишем там путь к файлу автора, мы просто подразумеваем, что есть коллекция people, где мы будем искать этот ник. Так же и с обложкой.

Плюс стоит решить одиночные или двойные кавычки. Мне кажется, что лучше одиночные :)

[monochromer]

Мне больше нравится, когда сначала идут все поля, которые непосредственно относятся к контенту, затем люди, затем "бизнес"-поля:

title
description
cover

authors
contributors
editors

keywords
tags

[pepelsbey]

Выглядит здорово, +1

[nlopin]

Мы это уже запилили #1172 или осталось что-то еще по этой теме?

Если всё готово, то давайте напишем итог, пометим его как верный ответ и закроем топик

[solarrust]

Поддерживаю предыдущего оратора!
@pepelsbey

[pepelsbey]

У нас уже есть решение, оно описано во frontmatter.json