Skip to content
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

Функционал "Документы" #13

Open
4 tasks
redboo opened this issue Apr 21, 2022 · 2 comments
Open
4 tasks

Функционал "Документы" #13

redboo opened this issue Apr 21, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@redboo
Copy link
Collaborator

redboo commented Apr 21, 2022

  • список
  • просмотр
  • создание
  • редактирование
@redboo redboo added the enhancement New feature or request label Apr 29, 2022
@ghost
Copy link

ghost commented Oct 5, 2022

На основании недавнего обсуждения предлагаю реализовать функционал заметок по шагам.

Шаг 1: разметка интерфейса

На фронтенде сделать следующее:

  • ниспадающий список для выбора локальных заметок
  • кнопка для скачивания всех локальных заметок
  • форма для добавления заметок. На форме присутствуют поля для следующих данных: заголовок, тело, теги.
  • кнопка локального сохранения заметки
  • кнопка публикации заметки в репозиторий TVP-Support/knowledge

Шаг 2: Локальное сохранение

Заметка хранится в локальном хранилище браузера: LocalStorage

Функционал такой:

  • при нажатии на кнопку сохранения заметка сохраняется, появляется в ниспадающем списке
  • при открытии старницы происходит чтение хранилища и построение ниспадающего списка
  • при выборе заметки из ниспадающего списка она появляется в форме ввода.

Шаг 3: Отправка заметки в общий репозиторий

При нажатии кнопки публикации происходит следующее:

  1. Если пулл-реквест существует, то заметка пушится в него, иначе создаётся новый пулл-реквест.
  2. При успешной публикации заметки под заголовком появляется надпись "Заметка на рассмотрении"

При открытии заметки происходит проверка пулл-реквеста: если пулл-реквест одобрен и влит в общую ветку, то под заголовком появляется надпись "Заметка опубликована". Это значит, что заметка попала в общий репозиторий базы знаний и теперь доступна для поиска через бот на Дискорде или Телеграме.

Пулл-реквест всегда создаётся в одной ветке с одинаковым для всех пользователей названием: "publicate-to-knowledge", например

Шаг 4: Идентификация заметки, Обновление заметки

В этом шаге решить, как будет хранится служебная информация о публикации заметке (пул-реквесты, хеш и прочее)


Такой вариант позволит заниматься реализаций приложения в виде отдельной странице при катастрофической нехватке времени.

@redboo redboo changed the title feat: notes (заметки) Функционал "Заметки" Mar 16, 2023
@1Anastasios1
Copy link

1Anastasios1 commented May 28, 2023

Можно начать разрабатывать на основе "Маркдаун" со своими дополнениями. Предлагаю рабочее название " ActiveNotes"

@redboo redboo changed the title Функционал "Заметки" Функционал "Документы" May 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

2 participants