首页 > 政策 > 官方版块--Filecoin完成大规模Spec升级
浙江云储  

官方版块--Filecoin完成大规模Spec升级

摘要:2020年10月14日,Filecoin官方团队发布其进行了一个巨大的Spec升级。云储科技小助手团队第一时间捕捉到相关讯息,接下来带您了解此次有关Spec升级

2020年10月14日,Filecoin官方团队发布其进行了一个巨大的Spec升级。云储科技小助手团队第一时间捕捉到相关讯息,接下来带您了解此次有关Spec升级的热点讯息!

搬自于:https://filecoin.io/blog/filecoin-spec-update/

6c0ee104c8250a94a5e5ad596f8a4e09

在过去的几个月里,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!

212886a1b47d1823c0a804f5a70fb0b1

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 Modules

  • Seamless math support through katex

  • New 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!

67b4b12089f6887d8981f4718c0b8889

在内容方面,我们花费了大量的精力来更新协议说明。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.

a63b1ee447f22430092f886526bae6d8

现在,规范网站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!

a3fbe3282d60f0d30fed2dd53374ce43

“审核完成”指示器,作为指示板的一列,显示协议的特定组件是否已被审核。在提供审计报告的地方,会有一个报告(或以前报告的列表)的链接,以及审计发生的日期。

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.

c28a84c34975dbf597cb9bc0360ae8e9

稳定进度条,总结整个规范的状态。

A stabilisation progress bar that summarises the state of the whole specification.

735a1c62bb1c68c4eef730dcb7852502

一个独立的“实施状态”仪表盘,包含所有不同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.

9f8c055ffb0913d3447da37a8d24b039

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 spec

  • Your feedback on the site and process of updating the spec

  • Ideas 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.

免责声明
世链财经作为开放的信息发布平台,所有资讯仅代表作者个人观点,与世链财经无关。如文章、图片、音频或视频出现侵权、违规及其他不当言论,请提供相关材料,发送到:2785592653@qq.com。
风险提示:本站所提供的资讯不代表任何投资暗示。投资有风险,入市须谨慎。
世链粉丝群:提供最新热点新闻,空投糖果、红包等福利,微信:juu3644。