-
Notifications
You must be signed in to change notification settings - Fork 487
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Перевести tlroadmap в честный веб #257
Labels
Milestone
Comments
В идеале эти требования выше и сам сайт отдать на растерзание и поиск ошибок в комьюнити, многое мы наверняка не учли |
@b0g3r кажется, можем закрывать уже? |
Я бы как эпик оставил |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
tlroadmap -> https://tlroadmap.io
Кажется, пришло время оформить наполовину сделаную работу в виде полноценного ишью.
Зачем tlroadmap уезжать в веб?
tlroadmap из небольшого .mm файла и набора статей превратился в базу знаний, которая усложнялась и будет постепенно усложняться дальше: генерация артефактов, проверки, шаблонные файлы, перекрёстные связи, переводы, глоссарий, ...
При этом пользоваться им становится всё сложнее с обоих сторон: читателю приходится качать файл / перебирать репозиторий, а писателю разбираться с флоу, проверками и решать конфликты между разными версиями бинарных артефактов.
Какое решение?
Сейчас источником истины для дерева компетенций служит .puml файл с ссылками на .mm файлы, которые лежат в достаточно плоской структуре директорий. Из этого .puml-файла генерируются связанные артефакты: .png, .svg, .mm, часть .md и кладутся в репозиторий.
Что я предлагаю:
Например из такой структуры файлов:
Должен генерироваться сайт с такой структурой:
Что нужно предусмотреть:
Какие технические детали?
Я и @teners реализовали большую часть из озвученных выше штук, использовав следующую магию:
ru.md
Есть и подводные камни:
Что теперь?
Когда все из обязательных условий будут выполнены форк b0g3r/tlroadmap будет влит в tlbootcamp/tlroadmap, и структура файлов в репозитории изменится.
Скорее всего вместе с этим сломаются все текущие PR :(
Чтобы отслеживать будущие ишью по сайту предлагаю создать лейбл
website
, и перенести оставшиеся в форке ишью в апстрим.После завершения работы над базовой функциональностью я предлагаю пустить зов по чатикам на лучший компонент для интерактивного отображения родмапа на сайте.
The text was updated successfully, but these errors were encountered: