Skip to content

Commit a718bbc

Browse files
avs51sokolov.a
andauthored
Add build backwards compatibility, fix linters (#262)
* [joinrpg-docs-253] fix hardcoded links * [joinrpg-docs-253] fix hardcoded links * [joinrpg-docs-253] add backward compatibility to static paths * [joinrpg-docs-253] add backward compatibility to static paths * [joinrpg-docs-253] change workflow names * [joinrpg-docs-253] fix by linter * [joinrpg-docs-253] fix workflows * [joinrpg-docs-253] fix by linters * [joinrpg-docs-253] ignore howto warnings * [joinrpg-docs-253] fix by linters * [joinrpg-docs-253] fix by linters * [joinrpg-docs-253] fix by linters * [joinrpg-docs-253] add linter info to readme * [joinrpg-docs-253] remove rtd info from readme * [joinrpg-docs-253] fix hardcoded links * [joinrpg-docs-253] fix linters --------- Co-authored-by: sokolov.a <sokolov.a@selectel.ru>
1 parent 3bb9925 commit a718bbc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+124
-159
lines changed

.github/workflows/dev-deploy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build docs
1+
name: Build and deploy dev docs
22

33
on:
44
push:
@@ -29,7 +29,7 @@ jobs:
2929
- name: Build static files
3030
run: |
3131
cd docs
32-
make html
32+
make html-all
3333
3434
- name: Upload build artifact
3535
uses: actions/upload-artifact@v5.0.0

.github/workflows/prod-deploy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build docs
1+
name: Build and deploy prod docs
22

33
on:
44
push:
@@ -27,7 +27,7 @@ jobs:
2727
- name: Build static files
2828
run: |
2929
cd docs
30-
make html
30+
make html-all
3131
3232
- name: Upload build artifact
3333
uses: actions/upload-artifact@v5.0.0

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# joinrpg-docs
22

3-
[![Documentation Status](https://readthedocs.org/projects/joinrpg/badge/?version=latest)](http://joinrpg.readthedocs.io/ru/latest/?badge=latest)
3+
Linter warnings and errors:
4+
Actions - Build sphinx docs job - Build static files step
45

56
In this repository we have documentation for joinrpg. See http://docs.joinrpg.ru.
67
Maintainers: @tsareva, @dtrub

docs/Makefile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,17 @@ html:
5454
@echo
5555
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
5656

57+
.PHONY: html-old
58+
html-old:
59+
$(SPHINXBUILD) -b html -D html_baseurl='/ru/latest/' $(ALLSPHINXOPTS) $(BUILDDIR)/html/ru/latest
60+
@echo
61+
@echo "Old link style version for backward compatibility built in $(BUILDDIR)/html/ru/latest"
62+
63+
.PHONY: html-all
64+
html-all: html html-old
65+
@echo
66+
@echo "Build finished. HTML pages available at / and /ru/latest"
67+
5768
.PHONY: dirhtml
5869
dirhtml:
5970
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

docs/accommodation/rooms_for_participants.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Расселение участников
2-
=======================
2+
=====================
33

44
Для того, чтобы определить проживание участников в конкретных комнатах с конкретными соседями, воспользуйтесь меню **Прочее > Настройки > Поселение > (иконка «расселение» у нужного типа комнаты)**
55

@@ -8,7 +8,7 @@
88
:align: center
99
:alt: Список комнат
1010

11-
.. attetion:: Проживание назначается для **человека**, а не для персонажа. В случае смены игрока на роли новому игроку потребуется назначить тип проживания заново.
11+
.. attention:: Проживание назначается для **человека**, а не для персонажа. В случае смены игрока на роли новому игроку потребуется назначить тип проживания заново.
1212

1313
В комнату нельзя записать больше проживающих, чем мест в каждой комнате этого типа размещения. При заселении в комнату и добавлении новых соседей заявившиеся получают уведомления на электронную почту, также эта информация показывается в заявке в блоке «Проживание».
1414

@@ -20,7 +20,7 @@
2020
.. attention:: Список соседей со ссылкой на профиль joinrpg будет виден всем проживающим в этой комнате. Избегайте спойлеров для игроков!
2121

2222
Список участников для типа размещения
23-
---------------------------------
23+
-------------------------------------
2424

2525
На вкладке «Комнаты» типа размещения показываются все участники, в заявках которых указан этот тип. Сверху располагаются те, кто еще не приписан к конкретной комнате; те, чье проживание определено, расположены в ячейках соответствующих помещений. Каждая заявка сопровождается указанием, сколько из назначенной к оплате суммы (включая оргвзнос, цену за место проживания, другие выбранные опции) еще осталось оплатить.
2626

@@ -31,7 +31,7 @@
3131

3232

3333
Массовое заселение / выселение
34-
---------------------------------
34+
------------------------------
3535

3636
.. figure:: in_or_out.JPG
3737
:scale: 100 %
@@ -46,7 +46,7 @@
4646
Функция «Выселить всех» также доступна на странице со списком типов размещения. При ее использовании будут освобождены все комнаты всех типов разменения
4747

4848
Выбор проживающих для каждой комнаты
49-
--------------------------------------
49+
------------------------------------
5050

5151
.. figure:: in_for_room.JPG
5252
:scale: 100 %

docs/api/integration.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Интеграция ИТ систем
2-
========================
2+
====================
33

44
Данный документ призван обобщить опыт игр Deus Ex и Магеллан по тому, как удобно и правильно интегрировать бекенд вашей игры и joinrpg.
55
Предназначен для мастеров, у которых на игре есть некая ИТ-система, предоставляющая возможности в рамках игрового мира. В дальнейшем будем называть ее Система.
66

77
Привязка всего к персонажу
8-
-----------------------
8+
--------------------------
99
.. note:: Эти принципы мы считаем разумными для всех интеграций
1010

1111
Источником правды о персонажах на начало игры является данные из joinrpg. Это даст мастерам возможность вести всю информацию по игре в одном месте, использовать удобные и привычные инструменты для управления.
@@ -17,7 +17,7 @@
1717
3. На игре менять роль игроку (выпуск второй ролью).
1818

1919
Поля персонажа
20-
-----
20+
--------------
2121
Для хранения всех данных по персонажу надо использовать поля персонажа. В API это называется ``CharacterFields``.
2222

2323
Обратите внимание, что дополнительные данные по полям (например, метаданные по вариантам выпадаек) можно хранить в поле ``ProgrammaticalValue`` и загрузить при помощи `MetaDataApi_GetFieldsList <https://joinrpg.ru/swagger/index.html#/MetaDataApi/get_x_game_api__projectId__metadata_fields>`_.
@@ -30,28 +30,29 @@
3030
2. Использовать «красивый», игровой логин, который берется из какого-то поля персонажа, например ``dartvader@empire.local``
3131

3232
Пароль
33-
-----
33+
------
3434
Пароль в вашу систему рекомендуем хранить в поле персонажа типа PIN-код. Он будет создан автоматически (но при желании вы сможете вручную его отредактировать).
3535

3636
«В игре»
37-
-------
37+
--------
3838

3939
У персонажа есть флаг «В игре» — ``InGame``:
4040

4141
- становится ``true``, если игрок прошел регистрацию на игре;
4242
- становится ``false``, если игрок был выпущен новой ролью. В идеале он мог бы становится false, если бы Система сообщала joinrpg о смерти персонажа, но такой функционал не был реализован.
43+
4344
Для NPC он всегда ``false``, их надо обрабатывать отдельно (`#1034 <https://github.com/joinrpg/joinrpg-net/issues/1034>`_)
4445

4546

4647
Использование joinrpg в качестве бекенда
47-
------------
48+
----------------------------------------
4849

4950
Не рекомендуется использовать joinrpg в качестве непосредственного бекенда для вашего приложения. Мы не гарантируем соблюдения ваших требований по нагрузке и надежности. Правильный вариант, чтобы бекендом для вашего приложения был ваш сервис с вашей базой, который работает независимо от joinrpg.
5051

5152
Впрочем, если вы всегда запрашиваете данные `по одному персонажу по его Id <https://joinrpg.ru/swagger/index.html#/CharacterApi/get_x_game_api__projectId__characters__characterId_>`_, количество запросов не превышает сотен в час и вы готовы обеспечить стабильный канал до joinrpg, то это можно использовать как основной вариант. Преимущества: нет проблемы синхронизации.
5253

5354
Заливка Excel
54-
--------------
55+
-------------
5556

5657
.. note:: Подходит только для простых ИТ-систем и маленьких игр.
5758

@@ -68,7 +69,7 @@
6869
- не подходит, если игра большая (формирование Excel займет определенное время).
6970

7071
Онлайн-импорт
71-
-----------------
72+
-------------
7273

7374
.. note:: Мы рекомендуем этот вариант для сложных ИТ-систем
7475

docs/characters/slots.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _character-slot-label:
22

33
Шаблоны персонажей
4-
============
4+
==================
55

66
Шаблон персонажей - мастерский инструмент позволяющий создать одного персонажа (собственно, шаблон) на основании которого, при принятии заявки, будут созданы отдельные персонажи. Шаблону персонажей можно присваивать поля (в том числе и с предустановленным значением) и привязывать группы.
77

docs/checkin/during.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Включение регистрации на полигоне
2-
========================
2+
=================================
33

44
Чтобы начать регистрацию приезжающих на игру, пройдите в своем проекте:
55
**Прочее > Настройки > Настройки регистрации**
@@ -33,7 +33,7 @@
3333
:align: center
3434
:alt: Экран регистрации
3535

36-
На экране регистрации выводится список `раздатки <http://docs.joinrpg.ru/ru/latest/plot/handout.html>`_ — физических вещей, которые получает игрок на полигоне непосредственно перед игрой. В том случае, если вы не формировали конверты для игроков заранее, игрок может получить требуемые вещи по этому списку прямо на регистрации.
36+
На экране регистрации выводится список `раздатки </plot/handout.html>`_ — физических вещей, которые получает игрок на полигоне непосредственно перед игрой. В том случае, если вы не формировали конверты для игроков заранее, игрок может получить требуемые вещи по этому списку прямо на регистрации.
3737

3838
После нажатия кнопки «Зарегистрировать игрока» статус заявки меняется на «Игрок заехал», она учитывается в списке зарегистированных игроков и больше не отображается в списке персонажей, доступных для регистрации. В заявке автоматически оставляется комментарий «Пройдена регистрация на полигоне» от имени зарегистрировавшего мастера.
3939

docs/checkin/second-roles.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Выберите опцию «Разрешить выпуск вторыми ролями». Сохраните настройки.
1010

11-
Выпустить второй ролью можно только игрока, первая заявка которого на игру прошла `процесс регистрации <http://docs.joinrpg.ru/ru/latest/checkin/during.html>`_. Непринятые заявки и незарегистрированных игроков выпустить второй ролью нельзя.
11+
Выпустить второй ролью можно только игрока, первая заявка которого на игру прошла `процесс регистрации </checkin/during.html>`_. Непринятые заявки и незарегистрированных игроков выпустить второй ролью нельзя.
1212

1313
.. figure:: new_role.png
1414
:scale: 100 %
@@ -25,7 +25,7 @@
2525
:align: center
2626
:alt: Поиск по имени персонажа
2727

28-
После нажатия кнопки «Выпустить второй ролью» вы перейдете в интерфейс регистрации игрока новым персонажем. В том случае, если у персонажа, которым вы пытаетесь выпустить второй ролью, не заполнены какие-то обязательные поля, регистрация будет невозможна, но заявка уже будет привязана к этому персонажу. Перейдите на страницу персонажа и заполните все обязательные и рекомендуемые поля персонажа, `повторно пройдите процесс регистрации на полигоне <http://docs.joinrpg.ru/ru/latest/checkin/during.html>`_ для автоматически созданной заявки во второй роли.
28+
После нажатия кнопки «Выпустить второй ролью» вы перейдете в интерфейс регистрации игрока новым персонажем. В том случае, если у персонажа, которым вы пытаетесь выпустить второй ролью, не заполнены какие-то обязательные поля, регистрация будет невозможна, но заявка уже будет привязана к этому персонажу. Перейдите на страницу персонажа и заполните все обязательные и рекомендуемые поля персонажа, `повторно пройдите процесс регистрации на полигоне </checkin/during.html>`_ для автоматически созданной заявки во второй роли.
2929

3030
.. hint:: Через меню Персонажи > Проблемные персонажи мастера могут заранее заполнить недостающие поля, тогда выпуск новыми ролями будет происходить максимально оперативно.
3131

docs/checkin/statistic.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Статистика зарегистрированных
2-
========================
2+
=============================
33

44
Статистика по ходу регистрации доступна по ссылке **Прочее > Регистрация > Статистика по регистрации**.
55
Показывается число принятых заявок, еще не прошедших регистрацию.

0 commit comments

Comments
 (0)