Skip to content

Commit e50de34

Browse files
abaillycoot
abailly
authored and
coot
committed
Turn hakyll site into a docusaurus blog-only site
1 parent f4f73f2 commit e50de34

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+22047
-63
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
*~
2+
\#*
13
_cache
24
_site
35
dist-newstyle
6+
node_modules
7+
/.docusaurus/

‎README.md

+25-33
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,41 @@
11
# Cardano Development Updates
22

3-
This repository will host updates from the
4-
[cardano](https://github.com/input-output-hk/cardano-node) development teams.
5-
The generated website containing the updates can be found
6-
[here](https://input-output-hk.github.io/cardano-updates/).
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
74

8-
## Setup
5+
### Installation
96

10-
You need to install [git-lfs extension](https://git-lfs.github.com/). If you
11-
want to add a large file to the repository please consider using `git-lfs`.
7+
```
8+
$ yarn
9+
```
1210

13-
## Add an update
11+
### Local Development
1412

15-
To add an update create a file under `posts` directory which name is:
16-
`yyyy-mm-dd-TEAM.markdown`. Commit and push. The site will be built and
17-
deployed by a [github-action](https://github.com/input-output-hk/cardano-updates/actions).
13+
```
14+
$ yarn start
15+
```
1816

19-
The format of the posts is up to each team,
20-
except that everyone should start each post with a `# High level summary` section.
21-
This section will be used by technical writers to share information with the general public.
22-
The better suited this section is for the technical writers,
23-
the less chance there is for misinformation. It should ideally be one short paragraph.
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
2418

25-
Avoid using links which are not publicly accessible.
19+
### Build
2620

27-
## Serve the website locally
21+
```
22+
$ yarn build
23+
```
2824

29-
If you wish to preview changes before publishing them, you can serve the site
30-
locally with:
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
3126

32-
```bash
33-
cabal run site -- watch
34-
```
27+
### Deployment
3528

36-
The site can then be previewed in a browser at http://127.0.0.1:8000.
29+
Using SSH:
3730

38-
## Workflow
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
3934

40-
Each team is welcome to use whatever workflow that they prefer.
41-
The options include:
35+
Not using SSH:
4236

43-
* Pushing directly to the `main` branch.
44-
* Using pull requests as a way to involve the whole team before publishing.
45-
* Using pull requests to incrementally add to the report each day,
46-
and then merging at the end of a two week period.
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
4740

48-
Regardless of the workflow chosen, it is important that we strive to keep the git history clean.
49-
This means never force pushing on main, and usually having one commit per new post.
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎babel.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};

‎posts/2022-08-12-network.markdown ‎blog/2022-08-12-network.markdown

+22-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
1+
---
2+
title: Network Team Update
3+
slug: 2022-08-12-network
4+
authors:
5+
- name: Marcin Szamutolski
6+
title: Network Team Lead
7+
url: https://github.com/coot
8+
image_url: https://github.com/coot.png
9+
tags: [network]
10+
hide_table_of_contents: false
11+
---
12+
13+
```mdx-code-block
14+
import ReactPlayer from 'react-player'
15+
```
16+
17+
118
The networking team took an active part in the project iteration (PI) planning
219
session, see cardano-node [backlog](https://github.com/orgs/input-output-hk/projects/39) for detailed
320
outcomes.
421

522

6-
* We started working on a detailed design / implementation plan for gossip.
23+
* We started working on a detailed design / implementation plan for gossip.
724

825
* We merged [input-output-hk/ouroboros-network#3859](https://github.com/input-output-hk/ouroboros-network/pull/3859) which
926
sets the ouroboros-network repository for the single relay release.
@@ -21,13 +38,13 @@ outcomes.
2138
[input-output-hk/ouroboros-network#3921](https://github.com/input-output-hk/ouroboros-network/pull/3921)
2239

2340
* For easy of debugging we renamed a trace point:
24-
[input-output-hk/ouroboros-network#3922](https://github.com/input-output-hk/ouroboros-network/pull/3922)
41+
[input-output-hk/ouroboros-network#3922](https://github.com/input-output-hk/ouroboros-network/pull/3922)
2542

2643
* Duncan iterated on his simulation / visualisation. He also was able to
2744
identify and fix a bug in the simulator. The simulation contains 50 nodes.
2845
Dashed lines indicate and established connection, while solid lines indicate
2946
a TCP connection with fully open TCP window.
3047

31-
<video width=512 controls>
32-
<source src="/images/p2p-relay3.mp4" type="video/mp4">
33-
</video>
48+
```mdx-code-block
49+
<ReactPlayer playing controls url='/p2p-relay3.mp4' />
50+
```

‎blog/2022-08-12-network.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Network Team Update
3+
slug: 2022-08-12-network
4+
authors: coot
5+
tags: [network]
6+
hide_table_of_contents: false
7+
---
8+
9+
```mdx-code-block
10+
import ReactPlayer from 'react-player'
11+
```
12+
13+
14+
The networking team took an active part in the project iteration (PI) planning
15+
session, see cardano-node [backlog](https://github.com/orgs/input-output-hk/projects/39) for detailed
16+
outcomes.
17+
18+
19+
* We started working on a detailed design / implementation plan for gossip.
20+
21+
* We merged [input-output-hk/ouroboros-network#3859](https://github.com/input-output-hk/ouroboros-network/pull/3859) which
22+
sets the ouroboros-network repository for the single relay release.
23+
24+
* We identified a bug in the network simulator, which is fixed in the
25+
[input-output-hk/ouroboros-network#3852](https://github.com/input-output-hk/ouroboros-network/pull/3852).
26+
The above PR was reviewed.
27+
28+
* We set the tracing configuration for nodes which we deploy and fixed and
29+
identified some deployment hiccups. We identified some bugs in the RT view
30+
which were registered by the maintainers.
31+
[input-output-hk/ouroboros-network-ops#4](https://github.com/input-output-hk/ouroboros-network-ops/pull/4)
32+
33+
* We fixed typos in network-mux library:
34+
[input-output-hk/ouroboros-network#3921](https://github.com/input-output-hk/ouroboros-network/pull/3921)
35+
36+
* For easy of debugging we renamed a trace point:
37+
[input-output-hk/ouroboros-network#3922](https://github.com/input-output-hk/ouroboros-network/pull/3922)
38+
39+
* Duncan iterated on his simulation / visualisation. He also was able to
40+
identify and fix a bug in the simulator. The simulation contains 50 nodes.
41+
Dashed lines indicate and established connection, while solid lines indicate
42+
a TCP connection with fully open TCP window.
43+
44+
```mdx-code-block
45+
<ReactPlayer playing controls url='/p2p-relay3.mp4' />
46+
```

‎posts/2022-08-31-consensus.markdown ‎blog/2022-08-31-consensus.md

+12
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
---
2+
title: Consensus Team Update
3+
slug: 2022-08-31-consensus
4+
authors:
5+
- name: Damian Nadales
6+
title: Consensus Team Lead
7+
url: https://github.com/dnadales
8+
image_url: https://github.com/dnadales.png
9+
tags: [consensus]
10+
hide_table_of_contents: false
11+
---
12+
113
# Executive summary
214

315
- We did most of the heavy lifting required to integrate the Conway era.

‎posts/2022-09-01-ledger.markdown ‎blog/2022-09-01-ledger.md

File renamed without changes.

‎posts/2022-09-16-ledger.markdown ‎blog/2022-09-16-ledger.md

File renamed without changes.

‎posts/2022-09-19-db-sync.markdown ‎blog/2022-09-19-db-sync.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: DB Sync Team Update
3+
slug: 2022-09-19-db-sync
4+
tags: [db-sync]
5+
hide_table_of_contents: false
6+
---
7+
18
# DBSync Update
29

310
## New Tag
@@ -46,4 +53,3 @@ We made the db-sync [board public](https://github.com/orgs/input-output-hk/proje
4653
This allows db-sync to restart much faster, without the need to delete data and reinsert them. In
4754
the future it can also facilitate migrations in cases where the ledger snapshots have a breaking
4855
change, without the need to resync everything from genesis.
49-

‎posts/2022-09-20-consensus.markdown ‎blog/2022-09-20-consensus.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
title: Consensus Team Update
3+
slug: 2022-09-20-consensus
4+
authors: dnadales
5+
tags: [consensus]
6+
hide_table_of_contents: false
7+
---
8+
19
# Executive summary
210

311
- We proposed a fix for the performance degradation observed when running

‎posts/2022-09-27-network.markdown ‎blog/2022-09-27-network.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
---
2+
title: Network Team Update
3+
slug: 2022-09-27-network
4+
authors: coot
5+
tags: [network]
6+
hide_table_of_contents: false
7+
---
8+
9+
```mdx-code-block
10+
import ReactPlayer from 'react-player'
11+
```
12+
113
# Network Update
214

315
## Ouroboros Network
@@ -57,7 +69,7 @@ We also improved experience for contributors of `io-sim` and `typed-protocols` b
5769
## Typed Protocols
5870

5971
* We pushed a branch which identifies a GHC quirk:
60-
[coot/typed-protocols-rewrite-StateToken-problem](https://github.com/input-output-hk/typed-protocols/tree/coot/typed-protocols-rewrite-StateToken-problem).
72+
[coot/typed-protocols-rewrite-StateToken-problem](https://github.com/input-output-hk/typed-protocols/tree/coot/typed-protocols-rewrite-StateToken-problem).
6173
That's too be resolved in order to push forward review of the redesign in
6274
[PR input-output-hk/typed-protocols#3](https://github.com/input-output-hk/typed-protocols/pull/3).
6375
* As for `io-sim`, we wrote issue templates:
@@ -82,6 +94,7 @@ New features include:
8294
video resolution we like without having to tweak numbers (this example is
8395
scaled to fit 1080HD video resolution).
8496

85-
<video width=512 controls>
86-
<source src="/images/p2p-relay-5.mp4" type="video/mp4">
87-
</video>
97+
98+
```mdx-code-block
99+
<ReactPlayer playing controls url='/p2p-relay-5.mp4' />
100+
```

‎posts/2022-09-30-ledger.markdown ‎blog/2022-09-30-ledger.md

File renamed without changes.

‎posts/2022-10-04-db-sync.markdown ‎blog/2022-10-04-db-sync.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: DB Sync Team Update
3+
slug: 2022-10-04-db-sync
4+
tags: [db-sync]
5+
hide_table_of_contents: false
6+
---
7+
18
# DBSync Update
29

310

@@ -57,5 +64,3 @@ We worked on fixing an issue related to fetching pool metadata
5764
[1276](https://github.com/input-output-hk/cardano-db-sync/pull/1276).
5865
The issue which is described in
5966
[1270](https://github.com/input-output-hk/cardano-db-sync/issues/1270)
60-
61-

‎posts/2022-10-04-node-cli-api.markdown ‎blog/2022-10-04-node-cli-api.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Node API & CLI Team Update
3+
slug: 2022-10-04-node-cli-api
4+
tags: [cli-api]
5+
hide_table_of_contents: false
6+
---
7+
18
# Node-Api-Cli Update
29
# 2022-10-04 - 2022-10-18
310

@@ -43,4 +50,3 @@ The majority of the team's time was spent between getting `1.34.4` ready, addres
4350

4451
- [Stop running CI when the only changes are to docs](https://github.com/input-output-hk/cardano-node/pull/4263)
4552
- [Rename TestEnableDevelopmentHardForkEras](https://github.com/input-output-hk/cardano-node/pull/4341)
46-

‎posts/2022-10-05-consensus.markdown ‎blog/2022-10-05-consensus.md

File renamed without changes.

‎posts/2022-10-14-hydra.md ‎blog/2022-10-14-hydra.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Hydra Team Update
3+
slug: 2022-10-14-hydra
4+
authors: ch1bo
5+
tags: [hydra]
6+
hide_table_of_contents: false
7+
---
18

29
# High level summary
310

‎posts/2022-10-14-ledger.markdown ‎blog/2022-10-14-ledger.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
title: Ledger Team Update
3+
slug: 2022-10-14-ledger
4+
authors: JaredCorduan
5+
tags: [hydra]
6+
hide_table_of_contents: false
7+
---
8+
19
# High level summary
210

311
The ledger team is still primarily focused on addressing

‎posts/2022-10-18-consensus.markdown ‎blog/2022-10-18-consensus.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
title: Consensus Team Update
3+
slug: 2022-10-18-consensus
4+
authors: dnadales
5+
tags: [consensus]
6+
hide_table_of_contents: false
7+
---
8+
9+
110
# High-level summary
211

312
During the past two weeks, the consensus team worked on adding property test for

‎posts/2022-10-21-hydra.md ‎blog/2022-10-21-hydra.md

+12
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
---
2+
title: Hydra Team Update
3+
slug: 2022-10-21-hydra
4+
authors:
5+
- name: Sebastian Nagel
6+
title: Hydra Team Lead
7+
url: https://github.com/ch1bo
8+
image_url: https://github.com/ch1bo.png
9+
tags: [hydra]
10+
hide_table_of_contents: false
11+
---
12+
113
# High level summary
214

315
This week, the hydra team reviewed and addressed several open comments on the

‎posts/2022-10-27-crypto.markdown ‎blog/2022-10-27-crypto.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1+
---
2+
title: Crypto Team Update
3+
slug: 2022-10-27-crypto
4+
tags: [crypto]
5+
hide_table_of_contents: false
6+
---
7+
18
# High level overview
2-
The crypto team is primarily focusing in enabling SECP primitives, and preparing the KES agent. We are close to
3-
meeting the [acceptance criteria](https://github.com/input-output-hk/cardano-base/issues/315) in cardano-base,
4-
which lacks some editorial comments on the style of dQuandrant's PR, the inclusion of one additional test, and
5-
we are good to mark it as done. For the KES agent, we are still iterating over the best design of the solution,
9+
10+
The crypto team is primarily focusing in enabling SECP primitives, and preparing the KES agent. We are close to
11+
meeting the [acceptance criteria](https://github.com/input-output-hk/cardano-base/issues/315) in cardano-base,
12+
which lacks some editorial comments on the style of dQuandrant's PR, the inclusion of one additional test, and
13+
we are good to mark it as done. For the KES agent, we are still iterating over the best design of the solution,
614
but also progressing on the implementation.
715

816
# Low level overview
@@ -11,6 +19,6 @@ but also progressing on the implementation.
1119
* CIP-0049 was addressed in the editors meeting, and [PR 250](https://github.com/cardano-foundation/CIPs/pull/250) was merged
1220
* The unit-tests [PR 320](https://github.com/input-output-hk/cardano-base/pull/320) is opened. Some editorial concerns still need to be addressed, and an additional (negative) test has been requested for addition.
1321

14-
## KES agent
22+
## KES agent
1523
* We were working in investigating how to send OpCerts to KES agents, but turns out to be not necessary. OpCerts can be stored on-disk, so the agent does not need to be aware of them.
16-
* We are redesigning the architecture. Instead of connecting the control server to the agent, and then the latter to the node, we are directly connecting the control server to the node, and the latter to the agent(s).
24+
* We are redesigning the architecture. Instead of connecting the control server to the agent, and then the latter to the node, we are directly connecting the control server to the node, and the latter to the agent(s).

‎posts/2022-10-28-network.markdown ‎blog/2022-10-28-network.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
title: Network Team Update
3+
slug: 2022-10-28-network
4+
authors: coot
5+
tags: [network]
6+
hide_table_of_contents: false
7+
---
8+
19
# High-level summary
210

311
## P2P Network Stack

‎posts/2022-10-28-sre.markdown ‎blog/2022-10-28-sre.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: SRE Team Update
3+
slug: 2022-08-12-sre
4+
tags: [sre]
5+
hide_table_of_contents: false
6+
---
7+
18
# High level summary
29

310
The SRE team is heavily working on the Equinix Metal migration, replacing Hydra

0 commit comments

Comments
 (0)