Jandig: улучшить руководство "как публиковать контент"

@discombobulateme , не могли бы вы взглянуть на эту документацию и предложить некоторые улучшения?

Это связано с фактической документацией.

В понедельник, 21 сентября 2020 г., в 21:54, Матеус Саллес Бланко <
уведомления@github.com> написал:

Связана ли эта проблема с фактической ручной документацией? Или к
учебник в приложении о том, как публиковать, что нужно улучшить?

—
Вы получаете это, потому что вы создали тему.
Ответьте на это письмо напрямую, просмотрите его на GitHub
https://github.com/memeLab/Jandig/issues/244#issuecomment-696457035 или
отписаться
https://github.com/notifications/unsubscribe-auth/AAH4ULG6BN72GEWAOFVYY33SG7YT7ANCNFSM4I5SVXAA
.

--
Анджело Пиксель
https://www.linkedin.com/in/vjpixel/

Это связано с фактической документацией.
…
В понедельник, 21 сентября 2020 г., в 21:54, Матеус Саллес Бланко < @ . * > написал: Связана ли эта проблема с фактической ручной документацией? Или к учебнику в приложении о том, как публиковать, который должен быть улучшен? — Вы получаете это, потому что вы создали тему. Ответьте на это письмо напрямую, просмотрите его на GitHub < # 244 (комментарий) > или отмените подписку https://github.com/notifications/unsubscribe-auth/AAH4ULG6BN72GEWAOFVYY33SG7YT7ANCNFSM4I5SVXAA .
-- Анджело Пиксель https://www.linkedin.com/in/vjpixel/

Понятно! Большое тебе спасибо!

Если вам нужна дополнительная помощь, пингуйте меня.

Привет, я хотел проверить некоторые сомнения относительно этой документации.

Во-первых, о его языке. Мы написали это руководство на английском языке и хотели бы знать, подходит ли оно португальскому языку для пользователей.

Во-вторых, о структуре просмотра документов. Я полагаю, что Jandig использует Sphynx для компиляции и отображения своей документации, верно? Когда я запустил локальную сборку на своем компьютере, DJANGO выдал ошибку, связанную с файлом index.html, когда я попытался получить доступ к странице «Справка». Это произошло как в ветке разработки, так и в ветке, созданной для этой конкретной проблемы.

Вот скриншот ошибки, отображаемой в браузере:

И когда я попытался найти его в коде, в файле index.rst в папке docs была ошибка:

Это ожидаемая ошибка? Требуется ли определенная конфигурация для доступа к странице справки?

Привет Матеус,

Я вижу, что вы написали руководство на английском языке. Это удивительно, потому что мы хотим привлечь больше международных пользователей.

Но большинство наших пользователей говорят по-португальски, поэтому лучше оставить обе версии.

Как вы думаете, можно ли перевести новую версию на португальский язык, чтобы у нас было и то, и другое?

@pablodiegoss может ответить о сфинксе лучше меня.

Привет Матеус,

Я вижу, что вы написали руководство на английском языке. Это удивительно, потому что мы хотим привлечь больше международных пользователей.

Но большинство наших пользователей говорят по-португальски, поэтому лучше оставить обе версии.

Как вы думаете, можно ли перевести новую версию на португальский язык, чтобы у нас было и то, и другое?

@pablodiegoss может ответить о сфинксе лучше меня.

Да, конечно. Я пока оставлю запрос на слияние с тегом WIP, чтобы я мог его перевести.

Это сделано! Я изменил тег на ОБЗОР.

Во-вторых, о структуре просмотра документов. Я полагаю, что Jandig использует Sphynx для компиляции и отображения своей документации, верно? Когда я запустил локальную сборку на своем компьютере, DJANGO выдал ошибку, связанную с файлом index.html, когда я попытался получить доступ к странице «Справка». Это произошло как в ветке разработки, так и в ветке, созданной для этой конкретной проблемы.

Вот скриншот ошибки, отображаемой в браузере:

Ваш комментарий верен, мы используем файлы .rst для описания наших документов и Sphinx для создания из них html-файлов, которые django-docs маршрутизирует и делает их доступными через «/docs».

Удивительно, что вы заметили эту ошибку, мы переместили некоторые папки в одном обновлении, и теперь Sphinx не смог найти index.html, который он сгенерировал ранее. Я нашел проблему и отправил исправление в ветку разработки. Можете ли вы проверить, возникает ли ошибка после извлечения этого коммита?

И когда я попытался найти его в коде, в файле index.rst в папке docs была ошибка:

Это ожидаемая ошибка? Требуется ли определенная конфигурация для доступа к странице справки?

Кажется, это просто ошибка вашего редактора, который не может распознать синтаксис RST... похоже, вы используете VScode, верно?
Я использую расширение reStructuredText, чтобы сначала получить подсветку синтаксиса и предложения, возможно, установка какого-либо расширения решит вашу проблему.

Удивительно, что вы заметили эту ошибку, мы переместили некоторые папки в одном обновлении, и теперь Sphinx не смог найти index.html, который он сгенерировал ранее. Я нашел проблему и отправил исправление в ветку разработки. Можете ли вы проверить, возникает ли ошибка после извлечения этого коммита?

@pablodiegoss Я тестировал здесь, в нашей ветке, и ваш последний коммит решил проблему 😄

Извините за задержку. Я только что прокомментировал # 330 .

Привет! Поскольку этот PR уже был слит, можно ли закрыть этот вопрос?

Ага!