WordPress貢獻者尋求改善古騰堡開發人員文檔的贊助

WordPress貢獻者尋求贊助以改善Gutenberg開發人員文檔WordPress貢獻者尋求贊助以改善Gutenberg開發人員文檔

WordPress開發人員 米蘭娜帽喬納森·波森格 正在啟動一項籌款活動,以改善古騰堡開發人員的文檔。 對話於昨天開始,當時Cap在推特上發布了有關公司聘請專職人員從事WordPress工作時經常被忽略的文檔的推文。

Cap說:「當社區無法學習您的軟體時,您就沒有貢獻者了。」 「文檔和教程對開源軟體項目的重要性遠遠超過人們的認識。」

Cap第一次開始索要Gutenberg文檔是在2017年巴黎的社區峰會上。從那時起,她一直在努力吸引社區的注意。

Cap說:「對於開發人員來說,塊編輯器文檔中有很多漏洞,但最明顯的是如何開始。」 「的開始 開發人員文檔 什麼也沒說。 「它只說您可以用一個塊做什麼,而不能說_how_。 初級開發人員,僅PHP開發人員以及該文檔所針對的任何人都不知道塊的代碼外觀,放置位置,如何包含塊等,更不用說如何使用自定義組件構建自定義塊了,設置。」

文檔化塊編輯器的部分挑戰在於它正在積極開發中。 不斷地對Gutenberg插件進行增強和改進,跟蹤內核中當前可用或不可用的內容並不總是那麼容易。 由於WordPress迫在眉睫 介紹塊目錄搜索,這是正式建立塊創建文檔的好時機。

Cap說:「整個文檔都缺少代碼示例,」。 「存在最基本的示例,但是缺少如何實際構建可用的東西。 因此,在第一頁上,我們被發送到一個教程,但是該教程並未針對從未構建過塊的人進行優化。 緊隨其後,我已經並且將無法建立該區塊。」

Marcus Kazmierczak和一組文檔提供者正在嘗試重建官方塊編輯器手冊中的教程。 一個GitHub 問題 專註於解決當前開發人員文檔中的空白的地方是關於為阻止開發的新手重寫文檔的最佳方法的積極討論的所在地。

卡普說:「這是一個很好的開始,但仍有很多工作要做。」 「完整的文檔是由了解和理解React和Gutenberg但被知識所吸引的人編寫的。」 他們沒有太多時間花在了解別人不知道的多少以及應該寫哪些詳細文檔上。 老實說,我認為他們不應該花時間在那上面。 我們有一個文檔團隊,我們願意加入,但是某種橋樑是必要的。」

古騰堡開發人員文檔的問題:對新來者不友好

「在塊編輯器文檔中,我看到的’問題’是,與其他WordPress文檔不同,它是為有經驗的JavaScript開發人員編寫的,而不是針對初學者的,」 Bossenger說。 「我還應該指出,這絕不是對將當前文檔整理在一起的人們的一個鏡頭,並且我感謝他們到目前為止所做的所有工作,這非常需要審查和完善。 」

Bossenger表示,過去,WordPress使擁有有限PHP知識的任何人都可以使用動作和過濾器掛鉤快速構建插件或主題。 查看代碼並理解應該執行的操作很容易。

Bossenger說:「現代JavaScript,特別是React,是一種截然不同的魚。」 「它需要對React如何工作有更深入的了解,包括新的術語和實踐。 現代JavaScript也可能非常令人困惑,尤其是在這是您第一次看到箭頭功能或不太冗長的if語句時。

「如果您最接近在WordPress中使用JavaScript的人一直在使用jQuery,那麼切換到基於React的Gutenberg開發仍然需要您一些學習。」

Bossenger在參加了兩門課程之後,才能為編輯器建立任何東西,一門在React上,一門在Gutenberg上。Bossenger說,當前的Block Editor手冊不是為沒有React和現代JavaScript經驗的開發人員編寫的。 他認為,需要對其進行重組,以更好地解釋新概念並適應新手更容易使用的模式。 他強調了 插件開發人員手冊 例如,各章遵循一種結構並使用更像是一本教科書的術語,從而向讀者慢慢介紹新概念。

Bossenger說:「我認為,如果沒有任何插件或PHP知識的人,只要擁有本手冊和Google,就有可能很快構建一個簡單的插件來滿足他們的特定要求。」 「目前,塊編輯器手冊不利於此。」

Bossenger對當前文檔並不孤單。 Delicious Brains的Peter Tasker最近發布了有關 創建一個自定義的古騰堡塊。 即使在過去的一年中全職工作於React,他仍然發現官方的塊編輯器文檔「種類繁多」且難以解析。

在Cap談到缺乏公司全職從事文檔工作的評論之後,Bossenger用一條推文測試了這片水域,詢問這兩家公司是否有能力籌集資金來改善Gutenberg文檔。

卡普說:「與團隊編輯團隊(和任何其他Make團隊一樣),文檔團隊人員不足。」 「我們負擔不起幾個成員先學習然後編寫有關使用塊編輯器進行開發的文檔的負擔。 這是我發推文的主要原因。 您會看到所有贊助者都來自核心,但沒有文檔,我敢說兩者同等重要。」

在啟動籌款活動之前,Cap and Bossenger計劃仔細閱讀現有文檔,找出明顯的漏洞,並找出對於塊編輯器開發新手來說仍未解決的問題。

她說:「一旦有了計劃,我們就可以預測每個零件需要多少時間。」 「有了這項計劃,我們將尋找贊助商。 我認為甚至可以在此之前進行捐贈,但是目前還不確定。」

區塊是WordPress開發的新領域。 為初學者投資可靠的文檔和教程可能會對擴展區塊鏈生態系統產生重大影響。 這也間接給用戶帶來了好處,因為在定製他們的WordPress網站時,他們最終獲得了更加多樣化的塊目錄以供選擇。

Bossenger和Cap目前正在為文檔制定計劃,然後再宣布其籌款活動。 同時,任何想為改進區塊創建文檔做出貢獻的人都可以加入GitHub 討論區

像這樣:

喜歡載入中……

資源

相關文章