Skip to content

Commit

Permalink
fix: add impls section and shortcode for dashboard (#1011)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugomrdias committed Jul 24, 2020
1 parent f2f5f65 commit 75cc859
Show file tree
Hide file tree
Showing 11 changed files with 136 additions and 15 deletions.
16 changes: 16 additions & 0 deletions content/implementations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Implementations
weight: 8

dashboardhidden: true
---

# Filecoin Implementations
---

In the meantime, you can follow each implementation’s progress at its respective repo on GitHub:

{{<dashboard-impl>}}

https://filecoin.io/blog/announcing-filecoin-implementations-in-rust-and-c++/

16 changes: 16 additions & 0 deletions content/implementations/forest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Forest
weight: 3
implAudit: 0
implSpecCompliance: 0
implRepo: https://github.com/ChainSafe/forest
---

# Forest is an implementation of Filecoin written in Rust
---

Forest is an implementation of Filecoin written in Rust. The implementation will take a modular approach to building a full Filecoin node in two parts — (i) building Filecoin’s security critical systems in Rust from the Filecoin Protocol Specification, specifically the virtual machine, blockchain, and node system, and (ii) integrating functional components for storage mining and storage & retrieval markets to compose a fully functional Filecoin node implementation.

https://github.com/ChainSafe/forest

https://chainsafe.github.io/forest/
14 changes: 14 additions & 0 deletions content/implementations/fuhon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Fuhon (cpp-filecoin)
weight: 4
implAudit: 0
implSpecCompliance: 0
implRepo: https://github.com/filecoin-project/cpp-filecoin
---

# Fuhon (cpp-filecoin)
---

C++17 implementation of blockchain based digital storage

https://github.com/filecoin-project/cpp-filecoin
14 changes: 14 additions & 0 deletions content/implementations/go-filecoin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Filecoin (go-filecoin)
weight: 2
implAudit: 0
implSpecCompliance: 0
implRepo: https://github.com/filecoin-project/go-filecoin
---

# Filecoin (go-filecoin)
---

The original Filecoin node implementation in Go.

https://github.com/filecoin-project/go-filecoin
17 changes: 17 additions & 0 deletions content/implementations/lotus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Lotus
weight: 1

implAudit: 0
implSpecCompliance: 0
implRepo: https://github.com/filecoin-project/lotus
---

# Lotus
---

Lotus is an implementation of the Filecoin Distributed Storage Network. You can run the Lotus software client to join the Filecoin Testnet.

https://github.com/filecoin-project/lotus


6 changes: 5 additions & 1 deletion content/intro/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,8 @@ over time, without requiring further interaction from the original parties
## Spec Status Overview
{{<dashboard-progress>}}

{{<dashboard-table>}}
{{<dashboard-spec>}}

## Implementations Status

{{<dashboard-impl>}}
4 changes: 0 additions & 4 deletions content/systems/filecoin_blockchain/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ dashboardTests: 0
# Blockchain
---

## Status Overview

{{<dashboard-level open="true">}}

The Filecoin Blockchain is a distributed virtual machine that achieves consensus, processes messages, accounts for storage, and maintains security in the Filecoin Protocol. It is the main interface linking various actors in the Filecoin system.

It includes:
Expand Down
6 changes: 1 addition & 5 deletions content/systems/filecoin_token/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,4 @@ dashboardTests: 0
---

# Token
---

## Status Overview

{{<dashboard-level open="true">}}
---
5 changes: 0 additions & 5 deletions content/systems/filecoin_vm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,4 @@ dashboardTests: 0
# VM - Virtual Machine
---

## Status Overview

{{<dashboard-level name="Virtual Machine" open="true">}}


{{<embed src="vm.id" lang="go" >}}
53 changes: 53 additions & 0 deletions layouts/shortcodes/dashboard-impl.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<table id="dashboard-impls" class="sort">
<thead>
<tr>
<th>Implementation</th>
<th>Test Coverage</th>
<th>Compliance Tests</th>
<th>Audit</th>
<th>CI</th>
</tr>
</thead>
<tbody>
{{- template "dashboard-impls-children" (dict "Section" ($.Site.GetPage "implementations") ) -}}
</tbody>
</table>

<!-- Children Template -->
{{ define "dashboard-impls-children" }}
{{- $pages := where .Section.Pages "Params.bookhidden" "ne" true -}}
{{- range sort $pages "Weight" "asc" -}}
{{ $parts := split .Params.implRepo "/" }}
{{ $size := len $parts }}
{{ $path := delimit (slice (index $parts (sub $size 2)) (index $parts (sub $size 1))) "/" }}
{{ $url := printf "https://codecov.io/api/gh/%s" $path }}
{{ $data := getJSON $url }}
{{ $cov := $data.commit.totals.c }}
{{ $color := "bg-na"}}
{{ if gt $cov 0 }}
{{ $color = "bg-incorrect"}}
{{ else if gt $cov 25 }}
{{ $color = "bg-wip"}}
{{ else if gt $cov 50 }}
{{ $color = "bg-incomplete"}}
{{ else if gt $cov 75 }}
{{ $color = "bg-stable"}}
{{ end }}
<tr>
<td><a title="{{.Title}}" href="{{.Permalink}}">{{.Title}}</a></td>
<td class="text-black {{ $color }}">
{{ if $data.commit.totals.c }}{{ math.Round $data.commit.totals.c }}%{{ else }}N/A{{end}}
</td>
<td class="text-transparent {{ if gt .Page.Params.implSpecCompliance 0 }}bg-stable{{ else }}bg-incorrect{{end}}">
{{ .Page.Params.implSpecCompliance }}
</td>
<td class="text-transparent {{ if gt .Page.Params.implAudit 0 }}bg-stable{{ else }}bg-incorrect{{end}}">
{{ .Page.Params.implAudit }}
</td>
<td class="text-transparent {{ if eq $data.commit.ci_passed true }}bg-stable{{ else if eq $data.commit.ci_passed false }}bg-incorrect {{ else }}bg-na{{end}}">

</td>
</tr>

{{ end }}
{{ end }}
File renamed without changes.

0 comments on commit 75cc859

Please sign in to comment.