Документация DotNetNuke действительно в значительной степени недействительна или доступна только в коммерческих изданиях?

Question

У меня проблемы с заявлением на страницах DotNetNuke о том, что документация доступна только тогда, когда вы платите 2000 долларов или больше за профессиональную или более высокую лицензию. Форумы наводнены вопросами, многие дублируются, многие остаются без ответа , несмотря на тяжелую работу сообщества DNN, чтобы не отставать от спроса.

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

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

Мне любопытно, почему продукт, который существует так долго, так плохо документирован на счет API? В конце концов, за этим стоит довольно крупная коммерческая компания, которая процветает благодаря расширяемости продукта. Правильно ли я понимаю, что вы получаете эту документацию, только если платите дорого? Или компании-разработчики модулей имеют особый доступ?

Answer 1

Я публикую здесь второй ответ, так как в пересмотренном вопросе есть совершенно другой взгляд на вещи.

Что касается профессионального руководства пользователя DotNetNuke, я думаю, что очень важно, чтобы вы точно поняли, что это за руководство. Это НЕ руководство разработчика или документация по API, это документация по пользовательскому интерфейсу. Как добавить страницу, как добавить модуль на страницу, как установить скин, вещи такого рода. Да, эта книга - «PE Feature», правда, неправильная или безразличная, она не поможет разработчику понять платформу DotNetNuke.

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

Есть и другие причины для этого, PE поставляется с несколькими модулями, которые недавно были приобретены корпорацией DotNetNuke, эти модули также должны иметь документацию, которая, как я полагаю, является еще одной частью документа UI, на который ссылается Ваша ссылка внутри поста.

Что касается форумов, да, я согласен, что они могут расстраивать. Это одна из причин того, что форумы на моем сайте (http://www.mitchelsellers.com) посещаются чаще, так как они получают немного лучшую экспозицию. Еще один интересный для сообщества элемент - мой недавно предложенный сайт DotNetNuke StackExchange . Если вы еще этого не сделали, я бы вышел и показал вашу поддержку!

В целом, хотя я чувствую вашу боль, я являюсь активным участником сообщества DotNetNuke уже более 4 лет, и иногда это может быть непросто, но в конце концов, оно всегда того стоит.

Answer 2

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

1. Документация по API доступна, хотя с истинной точки зрения API документация еще не на 100%. Справочная группа DotNetNuke работает над улучшением качества этой документации, но, как вы можете себе представить, потребуется много времени, чтобы получить документацию по API, в которой не было много, если таковая имеется, полной документации, но это конечная цель.

2. Книги, которые сейчас существуют, являются одними из лучших в целом документов по разработке DNN, НО они охватывают только определенную часть процесса. Например, в моей книге есть один из единственных элементов, которые документируют новый формат манифеста DNN 5.x, но, поскольку книга вышла более года, в манифест были добавлены элементы, которые не рассматриваются в книге.

3. Корпорация DotNetNuke пытается улучшить качество и доступность документации, создав новый проект Wiki и доведя документацию API до нюхательного табака, но это пошаговый процесс.

Но чтобы закончить, позвольте мне дать вам краткий совет: в сообществе DotNetNuke есть многие из нас, которые ломают наши задницы, чтобы помочь другим понять DNN и тратить все время, которое мы проводим здесь StackOverflow, DotNetNuke.com и даже наши личные форумы. Если вы будете использовать немного менее аргументированный подход, вы можете получить более точные ответы, и, как минимум, вы не рискуете раздражать людей, которые действительно могут ответить на ваши вопросы.

Answer 3

Я заметил это год назад (что, вероятно, подтверждается моей историей SO).

Отчасти, чтобы заполнить этот пробел, я прочитал большие красные книги и посмотрел много-много обучающих видео.Сейчас у меня второй год довольно крупного проекта;~ 50 пользовательских модулей DNN и два изменения ядра DNN: система быстрой перезаписи URL (помимо возможностей URLMaster) и пользовательский обработчик 404/301.

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

Если ничего из этого не звучит хорошо, просто задайте свои вопросы здесь, на SO - здесь достаточно сообщества, что это довольнохороший ресурс.

Answer 4

Руководства пользователя DotNetNuke теперь доступны онлайн здесь .Я полагаю, что скоро выйдет обновление для 5.5.0.

Будучи самым новым членом команды разработчиков DotNetNuke Corp. (около 2 месяцев), я могу заверить вас, что секретной документации по API нет.У меня есть копия тех же документов API, которые находятся в codeplex.Неудивительно, что документация по API ограничена, подавляющее большинство DNN написано разработчиками-добровольцами, которые предпочитают кодировать, а не писать комментарии, эта проблема не редкость среди проектов с открытым исходным кодом.Мое единственное преимущество перед остальным сообществом разработчиков DNN - это легкий доступ к некоторым давним членам основной команды, которые знают, как все должно работать.

В настоящее время существует проект по расширению документации API, DNN.Корпорация принимает участие и, как всегда, вклад сообщества очень приветствуется.Эрнст Питер Тамминга недавно писал об этом здесь .

Answer 5

Несмотря на отсутствие легко доступной документации, в которой подробно описывается API, который может удовлетворить ваши насущные потребности и / или стандарты, как утверждает Митчел, DNN имеет одно из лучших «сообществ» дизайнеров и разработчиков, которые стараются изо всех сил. помогать друг другу.

Существует множество книг, написанных с целью привлечения программиста или ИТ-специалиста к работе с DNN, хотя они могут не дать вам детали, которую вы ищете в конкретной области. Я уверен, что нет ни одной. Автор, который не сделает все возможное, чтобы ответить на вопрос, на который не ответили после прочтения книги, если бы вы связались с ними. Есть множество блогов и веб-сайтов, которые полны информации и форумов с людьми, которые охотно делятся своими знаниями с теми, кто пытается учиться. Я начал с того, что нанимал некоторых из тех, кто с начала работы с DNN работал на почасовой основе для индивидуального обучения (как я задаю вопросы, и они отвечают на них не в классе с «заранее разработанным» курсом). У большинства сайтов, которые продают модули, также есть форумы, и эти разработчики также стараются изо всех сил помогать другим учиться.

В короткие сроки и настойчивость окупятся как с любым другим фреймворком или языком. И, как заметил Митчел, «с мёдом можно поймать больше мух, чем с уксусом»

Кстати, что-то конкретно вы искали?

Answer 6

Когда я ищу общедоступные вызовы API в DotNetNuke, я использую .NET Reflector. Если вы не использовали его раньше, я думаю, это может быть именно то, что вы ищете (или больше). Это позволяет вам искать классы, методы и свойства. Вы можете предварять поиск с помощью DotNetNuke, чтобы отфильтровать не DNN. Когда вы найдете что-то, что выглядит правильно, это позволит вам увидеть точный код. Это бесплатно, и вам никогда не придется беспокоиться о том, что оно устарело, так как вы всегда можете ссылаться на последнюю DNN dll.

Answer 7

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