2020年10月14日，Filecoin官方團隊發布其進行了一個巨大的Spec升級。雲儲科技小助手團隊第一時間捕捉到相關訊息，接下來帶您了解此次有關Spec升級的熱點訊息！
搬自於：https://filecoin.io/blog/filecoin-spec-update/
在過去的幾個月裡，Filecoin在修訂規範和自定義網站方面取得了巨大的進展！大量的更新使得規格比以前精確了6倍多，完成度達到了85%，而且剩餘的細節已經在改進中。由於新的工作流程、身份徽章、搜索等等，貢獻規範和諮詢規範也得到了極大的改進。
Over the last few months, we have made massive progress revamping the Filecoin Specification and its custom website! There are a myriad of updates, which together made the spec over 6x more accurate than before, achieving an outstanding 85% completeness score with many of the remaining details already in progress. Contributing to the spec and consulting the spec has also been improved dramatically due to new workflows, status badges, search and more.
如果您最近還沒有訪問Filecoin Spec網站，請訪問https://spec.filecoin.io/，你將看到一個完全翻新的網站，裡面充滿更新的內容!
If you haven’t visited the Filecoin Spec site recently, head over to: https://spec.filecoin.io/ to see a fully refurbished website, full of updated content!
Spec網站經歷了好幾輪的「設計→實現→部署」，以整合為Filecoin開發者、實現者、研究人員和生態系統開發者創建更加出色的平臺所需的所有功能。此外，我們降低了更新規範內容所需的複雜性，應用了結構化依存管理，增加了確保整個規範一致性的特性，增加了對新工具的支持等等!
The Spec website went through several 「design → implement → deploy」 rounds, in order to integrate all the features essential to create a great platform for Filecoin developers, implementers, researchers and ecosystem developers. Additionally, we reduced the complexity required to update the spec content, applied structured dependency management, added features to ensure consistency throughout the spec, added support for new tools, and much more!
新的Filecoin規範貢獻工作流程
現在，更新spec內容變得更簡單、更令人愉快。包括在markdown文件進行「單點」編輯，後端機制負責其餘的工作，並自動更新目錄(ToC)和文檔結構！您可以在該規範的repo自述文件中找到所有需要的簡單說明。
Updating the spec content is now a much simpler and more enjoyable experience that involves 「single-touch」 edits in markdown files. The backend mechanics take care of the rest, updating the Table of Contents (ToC) and document structure automatically! You can find all the simple instructions needed in order to contribute in the spec’s repo README file.
更新後的網站最值得注意的功能分為以下幾類:
The most noteworthy features of the updated site are split into the following categories:
工具和語法：
通過npm和Go模塊無縫控制依存關係通過katex無縫進行數學支持新的markdown，帶有一些自定義規則，以確保內容降價的一致性，該內容在CI中最為測試運行。Seamless control over dependencies with npm and Go ModulesSeamless math support through katexNew markdown linter with some custom lint rules to ensure consistency in the content markdown, which runs in the CI as a test.圖表和代碼塊：
Mermaid和點處理管道(可以選擇在將來添加更多)與Hugo 伺服器很好地集成在一起，用於開發和內容編輯。可以使用符號短代碼從規範中引用，這樣即使代碼本身被修改，正確的代碼塊也會被引用，並從相應的存儲庫中提取出來。Mermaid and Dot processing pipelines (with an option to add more in the future) nicely integrated with Hugo server for development and content editing.Code can be referenced from the specification using symbol shortcodes so that the correct code block is referenced and pulled from the respective repository even if the codebase itself is modified.文檔層次結構：
從ToC中提取節編號，以便在重新組織節時自動更新ToC。不需要編輯單獨的文件來保持同步。部分深度連結集成。現在單頁呈現穩定了，並且部分結構也反映在ToC中。Section numbering is pulled from the ToC, so that the ToC is automatically updated once sections are reorganised. No need to edit separate files to keep things in sync.Section deep-linking integrated.Single page rendering is now stable and section structure is reflected in the ToC.除了這些隱藏的變化，網站外觀也進行了改版!
In addition to these background changes, the website got a facelift too!
在內容方面，我們花費了大量的精力來更新協議說明。Filecoin是一項龐大的工程。如果協議的規範被列印出來，那將是一本400頁的教科書!
On the content front, we have put a huge amount of effort in updating the description of the protocol. Filecoin is an enormous project. To put our effort into perspective, if printed, the specification of the protocol would be a ~400-page textbook!
Filecoin規範與實現無關，這意味著文本提供了使網絡運行的算法和協議交互的良好描述，而沒有涉及實現細節。該規範提供了開發人員在任何語言中實現Filecoin所需的所有細節。僅在需要時提供對Lotus實現的引用。
The Filecoin specification is implementation-agnostic, which means that the text provides a nice description of the algorithmics and protocol interactions that make the network operate, without going into implementation details. The specification provides all the required details that developers need in order to implement the Filecoin in any language. References to the Lotus implementation are provided only where needed.
測量進度
在我們3個月的Spec項目旅程中，開放了超過300個GitHub問題，超過200個PRs被合併。
In our 3-month Spec Project journey there were more than 300 GitHub issues opened and more than 200 PRs merged.
現在，規範網站84%的內容是最新的。為了跟蹤我們自己的進展，以及站點和協議的「健康」狀態，我們整合了三個出色的工具:
Today the spec site is 84% up-to-date. In order to keep track of our own progress, as well as the 「health」 state of the site and protocol, we have incorporated three great tools:
明亮的儀錶盤，顯示了規範中每個部分的「不正確」、「在成品/草案」、「可靠」和「穩定」的狀態。我們已經在spec markdown文件中集成了front matter屬性來自動將值提供給儀錶板，而且不需要任何額外的操作。還值得注意的是，儀錶板是從ToC自動生成和更新的。為了更新儀錶板，不需要編輯單獨的文件!
A bright dashboard that shows the state of each section of the spec in the range of 「Incorrect」, 「WIP/Draft」, 「Reliable」 and 「Stable」. We have integrated front matter properties in spec markdown files to feed the values automatically into the dashboard, without any extra action needed. It is also worth noting that the dashboard is generated and updated automatically from the ToC. There is no need to edit separate files in order to update the dashboard!
「審核完成」指示器，作為指示板的一列，顯示協議的特定組件是否已被審核。在提供審計報告的地方，會有一個報告(或以前報告的列表)的連結，以及審計發生的日期。
An 「audit-complete」 indicator as a separate column of the dashboard to show whether the specific component of the protocol has been audited. Where an audit report is available, there is a link to the report (or list of previous reports) together with the date when the audit took place.
穩定進度條，總結整個規範的狀態。
A stabilisation progress bar that summarises the state of the whole specification.
一個獨立的「實施狀態」儀錶盤，包含所有不同Filecoin實現的狀態信息：Lotus、Fuhon、Forest和go-filecoin。儀錶板集成了鉤子，無縫地從相應的存儲庫中提取信息，並報告CI測試的成功/失敗以及測試覆蓋率。
A separate 「Implementation Status」 dashboard with status information for all the different Filecoin implementations: Lotus, Fuhon, Forest and go-filecoin. The dashboard integrates hooks to seamlessly pull information from the corresponding repositories and reports CI test success/failure as well as test coverage.
FIP整合
經過幾輪測試和兩次令人印象深刻的太空競賽之後，該協議現在已經進行了微調，開始「發射」了！從現在開始，協議的變更將通過Filecoin改進建議(FIP)進行。對協議的建議更改必須經過一個明確指定的過程，該過程在FIP存儲庫中有詳細說明。
After several testing rounds and two impressive Space Race competitions, the protocol has now been fine-tuned and is ready for lift off! From now on, changes to the protocol will take place through Filecoin Improvement Proposals (FIPs). Suggested changes to the protocol have to go through a clearly specified process, detailed in the FIP repository.
在大多數情況下，FIP需要更新協議規範，因此我們正在進行的工作包括將Filecoin規範與FIP流程無縫集成。
In most cases, FIPs will require updates to the protocol specification and therefore one of the streams of our ongoing efforts include seamless integration of the Filecoin Spec with the FIP process.
下一步計劃
Filecoin還集成了規範版本控制，以創建規範本身的Time Machine，以便及時查看協議更新之前的規範。最後但同樣重要的是，Filecoin正在集成工具以通過API代理從遠程源中提取數據。這將實現與FIP的無縫集成，為了能夠擴展儀錶板，使其包括「一致性測試」的狀態。
We are also integrating spec versioning to create a Time Machine of the specification itself such that you can view back in time what the spec was prior to a protocol update. Last but certainly not least, we are integrating tools to pull data from remote sources through an API proxy. This will enable the seamless integration with FIPs but will also allow us to extend the dashboard to include the status of 「Conformance Tests」.
如果你是一個Filecoin開發者，研究員，礦工，或用戶，官方十分歡迎:
If you are a Filecoin developer, researcher, miner, or user, we』d love:
您對規範的貢獻您對站點和規範更新過程的反饋如何進一步改善用戶體驗的想法Your help contributing to the specYour feedback on the site and process of updating the specIdeas on how to improve the user experience even further在兩輪的太空競賽中，協議和規範已經有了重大的進展和升級，因此現在需要更加的努力，把Filecoin所有規範的儀錶板單元變為藍色！我們的目標是在接下來的幾周內擁有90%的可靠內容，在接下來的幾個月裡擁有100%的穩定內容。
There has been significant progress and upgrades to the protocol and its specification during the two rounds of Space Race, and as a result extra effort is now needed to paint all of the spec dashboard cells in Filecoin blue! We are shooting to have 90% reliable content in the next couple of weeks and 100% stable content in the next couple of months.
本文來源： 金色財經 / 作者：浙江雲儲