Jetpack запускает новый справочник по коду для разработчиков

На этой неделе команда Jetpack запустила сайт developer.jetpack.com , доступный для поиска справочник по коду действий, фильтров и функций плагина. Несмотря на то, что Jetpack разработан с учетом высокой расширяемости, до сих пор у разработчиков не было централизованного места для поиска документации. В справочнике представлены новые хуки, добавленные в самую последнюю версию, и их также можно переключать на другие версии.

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

По словам члена команды Jetpack Джереми Эрве, сайт был смоделирован по образцу кода WordPress .

«Он использует тот же синтаксический анализатор для создания документации из кодовой базы плагина, и его цели схожи: предоставить некоторую информацию людям, которые хотят узнать больше о конкретном хуке или хотят узнать, как настроить определенные аспекты Jetpack», — сказал Эрве. .

Эрве и другие члены команды написали множество постов с фрагментами кода , а совсем недавно — серию Hook of the Month, но наполнение встроенной документации заняло большую часть времени при запуске нового справочника.

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

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

«Прямо сейчас, я думаю, одна из первых вещей, в которых мы заинтересованы, — это получить обратную связь от разработчиков: считают ли они это полезным, чего не хватает, что мы можем улучшить?» — спросил Эрве. Просмотр примера фильтра, такого как jetpack_open_graph_tags , дает вам представление о типе контента, который команда надеется предоставить для дополнительных крючков. Отзывы приветствуются в объявлении или через форму поддержки Jetpack .