Skip to content

Commit

Permalink
[Documentation] Update Devlog Formatting (#512)
Browse files Browse the repository at this point in the history
## Description

Update formatting in the devlog READMEs

## Issue

Fixes #NA

## Type of change

Please mark the relevant option(s):

- [ ] New feature, functionality or library
- [ ] Bug fix
- [ ] Code health or cleanup
- [ ] Major breaking change
- [x] Documentation
- [ ] Other <!-- add details here if it a different type of change -->

## List of changes

- Added `GITHUB_WIKI` tag to the two wiki demos so it shows up in the [Github Wiki](https://github.com/pokt-network/pocket/wiki)
- Use [Visual Studio's](https://visualstudio.microsoft.com/) auto formatting to clean up headers
- Use the [Markdown All In One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) extension to auto-generate the table of contents
- Add a template we can copy-pasta for future devlogs
  • Loading branch information
Olshansk authored Feb 15, 2023
1 parent 8f8d4fb commit ecbb339
Show file tree
Hide file tree
Showing 6 changed files with 195 additions and 86 deletions.
2 changes: 1 addition & 1 deletion docs/demos/iteration_3_end_to_end_tx.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,4 @@ go run app/client/*.go --path_to_private_key_file=/tmp/val2.json Account Send 00
make swagger-ui
```

<!-- GITHUB_WIKI: guides/demos/iteration_three_end_to_end -->
<!-- GITHUB_WIKI: guides/demos/iteration_3_end_to_end_tx_poc -->
2 changes: 2 additions & 0 deletions docs/demos/iteration_9_localnet_infra.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,5 @@ make localnet_client_debug
2. Automate validator staking when scaling
3. Discover peers (nodes or actors) when connected to the network
4. Sync new nodes to the latest height

<!-- GITHUB_WIKI: guides/demos/iteration_9_k8s_localnet_and_logging -->
110 changes: 58 additions & 52 deletions docs/devlog/devlog1.md
Original file line number Diff line number Diff line change
@@ -1,91 +1,96 @@
### Pocket V1 DevLog Call #1 Notes <!-- omit in toc -->
# Pocket V1 DevLog Call #2 Notes <!-- omit in toc -->

##### Date and Time: Tuesday January 24th, 2023 18:00 UTC
##### Location: [Discord](https://discord.gg/pokt)
##### Duration: 60 minutes
##### [Feedback and Discussion Form](https://app.sli.do/event/eF13JYg93rGq4pGLRnHLF5)
- **Date and Time**: Tuesday January 24th, 2023 18:00 UTC
- **Location**: [Discord](https://discord.gg/pokt)
- **Duration**: 60 minutes
- [Recording](https://drive.google.com/drive/u/1/folders/1Ts6FHy3fcPjqjKl8grpd93L7DB1-N-LA)
- [Feedback and Discussion Form](https://app.sli.do/event/eF13JYg93rGq4pGLRnHLF5)

-----------------------------
---

### Contents <!-- omit in toc -->
## Agenda <!-- omit in toc -->

- [Current Iteration 🗓️](#current-iteration-%EF%B8%8F)
- [Upcoming Iteration 🗓️](#upcoming-iteration-%EF%B8%8F)
- [Feedback and Open Discussion 💡](#feedback-and-open-discussion-)
- [Current Iteration 🗓️](#current-iteration-️)
- [Iteration Goals 🎯](#iteration-goals-)
- [Iteration Results ✅](#iteration-results-)
- [External Contributions ⭐](#external-contributions-)
- [Upcoming Iteration 🗓️](#upcoming-iteration-️)
- [Feedback and Open Discussion 💡](#feedback-and-open-discussion-)
- [Q: Do we have a distributed tracing framework for collecting metrics?](#q-do-we-have-a-distributed-tracing-framework-for-collecting-metrics)
- [Contribute to V1 🧑‍💻](#contribute-to-v1-)
- [About Pocket Network 💙](#about-pocket-network-)

-----------------------------

<!-- toc -->
---

### Current Iteration 🗓️

##### Duration: January 11 - 24
##### [Backlog](https://github.com/orgs/pokt-network/projects/142/views/12?layout=table&filterQuery=iteration%3A%22Iteration+8%22)
- Duration: January 11 - 24
- [Backlog](https://github.com/orgs/pokt-network/projects/142/views/12?layout=table&filterQuery=iteration%3A%22Iteration+8%22)

### Iteration Goals 🎯

#### Iteration Goals 🎯
- M1: PoS
- P2P: Develop a simple Peer Discovery mechanism for LocalNet
- State Sync: Build a server to advertise blocks
- P2P: Develop a simple Peer Discovery mechanism for LocalNet
- State Sync: Build a server to advertise blocks
- M2: DoS
- Deploy 4 Node LocalNet in a remote environment and document
- Design MVP DevNet telemetry dashboard
- Deploy 4 Node LocalNet in a remote environment and document
- Design MVP DevNet telemetry dashboard
- M3: RoS
- Update Utility Spec to define permissionless application and gateway behavior
- Update Utility Spec to define permissionless application and gateway behavior

#### Iteration Results ✅
### Iteration Results ✅

- Completed
- https://github.com/pokt-network/pocket/pull/450
- https://github.com/pokt-network/pocket/issues/456
- https://github.com/pokt-network/pocket/pull/451
- https://github.com/pokt-network/pocket/pull/449
- https://github.com/pokt-network/pocket/pull/448
- https://github.com/pokt-network/pocket-network-protocol/pull/27
- https://github.com/pokt-network/pocket-network-protocol/pull/26
- https://github.com/pokt-network/pocket/pull/445
- https://github.com/pokt-network/pocket/pull/444
- https://github.com/pokt-network/pocket/pull/439
- https://github.com/pokt-network/pocket/pull/427
- https://github.com/pokt-network/pocket/issues/268
- https://github.com/pokt-network/pocket/pull/450
- https://github.com/pokt-network/pocket/issues/456
- https://github.com/pokt-network/pocket/pull/451
- https://github.com/pokt-network/pocket/pull/449
- https://github.com/pokt-network/pocket/pull/448
- https://github.com/pokt-network/pocket-network-protocol/pull/27
- https://github.com/pokt-network/pocket-network-protocol/pull/26
- https://github.com/pokt-network/pocket/pull/445
- https://github.com/pokt-network/pocket/pull/444
- https://github.com/pokt-network/pocket/pull/439
- https://github.com/pokt-network/pocket/pull/427
- https://github.com/pokt-network/pocket/issues/268
- In Review
- https://github.com/pokt-network/pocket/issues/195
- https://github.com/pokt-network/pocket-operator/issues/10
- https://github.com/pokt-network/pocket/issues/388
- https://github.com/pokt-network/pocket-network-protocol/pull/25
- https://github.com/pokt-network/pocket/issues/195
- https://github.com/pokt-network/pocket-operator/issues/10
- https://github.com/pokt-network/pocket/issues/388
- https://github.com/pokt-network/pocket-network-protocol/pull/25
- In Progress
- https://github.com/pokt-network/pocket/issues/409
- https://github.com/pokt-network/pocket/issues/416
- https://github.com/pokt-network/pocket/issues/409
- https://github.com/pokt-network/pocket/issues/416
- Refactored
- https://github.com/pokt-network/pocket-core/issues/1511
- Requires deeper investigation into data returned from exporter
- https://github.com/pokt-network/pocket/issues/307
- Blocked by internal infrastructure migration
- https://github.com/pokt-network/pocket-core/issues/1511
- Requires deeper investigation into data returned from exporter
- https://github.com/pokt-network/pocket/issues/307
- Blocked by internal infrastructure migration

### External Contributions ⭐

#### External Contributions ⭐
- https://github.com/pokt-network/pocket/pull/446
- https://github.com/pokt-network/pocket/pull/442
- https://github.com/pokt-network/pocket/pull/407

-----------------------------
---

### Upcoming Iteration 🗓️

##### Duration: January 25 - February 7
##### [Backlog Candidates](https://github.com/orgs/pokt-network/projects/142/views/12?layout=table&filterQuery=iteration%3A%22Iteration+9%22)
- Duration: January 25 - February 7
- [Backlog Candidates](https://github.com/orgs/pokt-network/projects/142/views/12?layout=table&filterQuery=iteration%3A%22Iteration+9%22)

-----------------------------
---

### Feedback and Open Discussion 💡

[Feedback and Discussion Form](https://app.sli.do/event/eF13JYg93rGq4pGLRnHLF5)

Q: Do we have a distributed tracing framework for collecting metrics?
#### Q: Do we have a distributed tracing framework for collecting metrics?

A: The logging module is being productionized so that it can be integrated with observability tooling like Prometheus. There currently is no distributed tracing of requests between protocol actors. Once the applied logging module has been merged (https://github.com/pokt-network/pocket/pull/420), distributed tracing (https://github.com/pokt-network/pocket/issues/143) can begin development.
A: The logging module is being productionized so that it can be integrated with observability tooling like Prometheus. There currently is no distributed tracing of requests between protocol actors. Once the applied logging module has been merged (https://github.com/pokt-network/pocket/pull/420), distributed tracing (https://github.com/pokt-network/pocket/issues/143) can begin development.

-----------------------------
---

### Contribute to V1 🧑‍💻

Expand All @@ -105,3 +110,4 @@ Pocket Network is a blockchain data platform, built for applications, that uses
- [Discord](https://discord.gg/pokt)
- [Twitter](https://twitter.com/POKTnetwork)

<!-- GITHUB_WIKI: devlog/2023_01_24 -->
69 changes: 38 additions & 31 deletions docs/devlog/devlog2.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,37 @@
### Pocket V1 DevLog Call #2 Notes <!-- omit in toc -->
# Pocket V1 DevLog Call #2 Notes <!-- omit in toc -->

##### Date and Time: Tuesday February 7, 2023 18:00 UTC

##### Location: [Discord](https://discord.gg/pokt)

##### Duration: 60 minutes

##### [Recording](https://drive.google.com/drive/u/1/folders/1Ts6FHy3fcPjqjKl8grpd93L7DB1-N-LA)

##### [Feedback and Discussion Form](https://app.sli.do/event/eF13JYg93rGq4pGLRnHLF5)
- **Date and Time**: Tuesday February 7, 2023 18:00 UTC
- **Location**: [Discord](https://discord.gg/pokt)
- **Duration**: 60 minutes
- [Recording](https://drive.google.com/drive/u/1/folders/1Ts6FHy3fcPjqjKl8grpd93L7DB1-N-LA)
- [Feedback and Discussion Form](https://app.sli.do/event/eF13JYg93rGq4pGLRnHLF5)

---

### Contents <!-- omit in toc -->
## Agenda <!-- omit in toc -->

- [Current Iteration 🗓️](#current-iteration-%EF%B8%8F)
- [Current Iteration 🗓️](#current-iteration-️)
- [Iteration Goals 🎯](#iteration-goals-)
- [Iteration Results ✅](#iteration-results-)
- [External Contributions ⭐](#external-contributions-)
- [Demo 💻](#demo-)
- [Upcoming Iteration 🗓️](#upcoming-iteration-%EF%B8%8F)
- [Feedback and Open Discussion 💡](#feedback-and-open-discussion-)
- [Contribute to V1 🧑‍💻](#contribute-to-v1-)
- [Upcoming Iteration 🗓️](#upcoming-iteration-️)
- [Feedback and Open Discussion 💡](#feedback-and-open-discussion-)
- [Q: Can Localnet scale to 999 validators?](#q-can-localnet-scale-to-999-validators)
- [Q: Were there other projects that inspired how to design the testing and deployment suite?](#q-were-there-other-projects-that-inspired-how-to-design-the-testing-and-deployment-suite)
- [Q: Other projects, like Cosmos, allow people to configure different backends for key storage. Is it worth surveying the community to see what backends the keybase should integrate with (e.g. Leveldb or Pass)?](#q-other-projects-like-cosmos-allow-people-to-configure-different-backends-for-key-storage-is-it-worth-surveying-the-community-to-see-what-backends-the-keybase-should-integrate-with-eg-leveldb-or-pass)
- [Q: In V0, the Private Key is a plain text in the server but not in the Keybase. In V1, is this all inside of the Keybase or will there be plain text PKs?](#q-in-v0-the-private-key-is-a-plain-text-in-the-server-but-not-in-the-keybase-in-v1-is-this-all-inside-of-the-keybase-or-will-there-be-plain-text-pks)
- [Contribute to V1 🧑‍💻](#contribute-to-v1-)
- [About Pocket Network 💙](#about-pocket-network-)

---

### Current Iteration 🗓️
## Current Iteration 🗓️

- Duration: January 25 - February 7
- [Backlog](https://github.com/orgs/pokt-network/projects/142/views/12?layout=table&filterQuery=iteration%3A%22Iteration+9%22)

#### Iteration Goals 🎯
## Iteration Goals 🎯

- M1: PoS
- Cont. developing a simple peer discovery mechanism for localnet
Expand All @@ -39,7 +42,7 @@
- M3: RoS
- Address utility foundation issues to unblock M3 implementation

#### Iteration Results ✅
## Iteration Results ✅

- Completed
- https://github.com/pokt-network/pocket/pull/354
Expand All @@ -60,7 +63,7 @@
- https://github.com/pokt-network/pocket/issues/473
- https://github.com/pokt-network/pocket/issues/475

#### External Contributions ⭐
## External Contributions ⭐

- https://github.com/pokt-network/pocket/pull/472
- https://github.com/pokt-network/pocket/pull/419
Expand All @@ -73,7 +76,7 @@

---

### Demo 💻
## Demo 💻

- Deploy a V1 Localnet using K8s
- Present infrastructure that can be used to deploy remote clusters
Expand All @@ -84,28 +87,32 @@ Try it out ➡️ [Demo Guide](https://github.com/pokt-network/pocket/blob/main/

---

### Upcoming Iteration 🗓️
## Upcoming Iteration 🗓️

- Duration: February 8 - 21
- Duration: February 8 - 21
- [Backlog Candidates](https://github.com/orgs/pokt-network/projects/142/views/12?layout=table&filterQuery=iteration%3A%22Iteration+10%22)

---

### Feedback and Open Discussion 💡
## Feedback and Open Discussion 💡

[Feedback and Discussion Form](https://app.sli.do/event/2LFSdaBzJ4FPYANPFcGxC7/live/questions)

##### Q: Can Localnet scale to 999 validators?
### Q: Can Localnet scale to 999 validators?

A: Containers will be created but the validators will not be participating in consensus until peer discovery is in place and those validators are staked it will be a 4 node network with many unstaked validators. So, technically, yes, but good luck with the resource consumption :)

##### Q: Were there other projects that inspired how to design the testing and deployment suite?
A: A lot of learning from V0 and a commitment to visibility that won't only allow us to iterate faster but all contributors (reduce dependencies on the core team to make changes to the protocol). We looked at a lot of different projects when we started but most projects don't have these tools in place. In general the Tendermint and Cosmos ecosystem is going that direction, but it's more difficult because they are dealing with legacy code rather than the greenfield of V1. One of the best projects heading this direction is Aptos. They have very mature infrastructure and test suite.
### Q: Were there other projects that inspired how to design the testing and deployment suite?

A: A lot of learning from V0 and a commitment to visibility that won't only allow us to iterate faster but all contributors (reduce dependencies on the core team to make changes to the protocol). We looked at a lot of different projects when we started but most projects don't have these tools in place. In general the Tendermint and Cosmos ecosystem is going that direction, but it's more difficult because they are dealing with legacy code rather than the greenfield of V1. One of the best projects heading this direction is Aptos. They have very mature infrastructure and test suite.

### Q: Other projects, like Cosmos, allow people to configure different backends for key storage. Is it worth surveying the community to see what backends the keybase should integrate with (e.g. Leveldb or Pass)?

##### Q: Other projects, like Cosmos, allow people to configure different backends for key storage. Is it worth surveying the community to see what backends the keybase should integrate with (e.g. Leveldb or Pass)?
A: The Keybase currently users badger.db to store locally in the file system. When it comes to key management, enabling anyone to integrate their own key manager into the codebase and identifying maybe one major integration. Please keep in mind that this is not useful for localnet but will be useful once we have a remote deployment.

##### Q: In V0, the Private Key is a plain text in the server but not in the Keybase. In V1, is this all inside of the Keybase or will there be plain text PKs?
A: The Keybase contains all the PK pairs associated with wallets only. Storing in the same way as V0 (base64) to allow for complete interoperability.
### Q: In V0, the Private Key is a plain text in the server but not in the Keybase. In V1, is this all inside of the Keybase or will there be plain text PKs?

A: The Keybase contains all the PK pairs associated with wallets only. Storing in the same way as V0 (base64) to allow for complete interoperability.

---

Expand All @@ -118,7 +125,7 @@ V1 is an open source project that is open to external contributors. Find informa
- [V1 Project Board](https://github.com/orgs/pokt-network/projects/142/views/12)
- [V1 Roadmap](https://github.com/pokt-network/pocket/blob/main/docs/roadmap/README.md#m1-pocket-pos-proof-of-stake)

### About Pocket Network 💙
## About Pocket Network 💙

Pocket Network is a blockchain data platform, built for applications, that uses cost-efficient economics to coordinate and distribute data at scale.

Expand All @@ -127,4 +134,4 @@ Pocket Network is a blockchain data platform, built for applications, that uses
- [Discord](https://discord.gg/pokt)
- [Twitter](https://twitter.com/POKTnetwork)

<!-- GITHUB_WIKI: devlog/2023_01_24 -->
<!-- GITHUB_WIKI: devlog/2023_02_07 -->
94 changes: 94 additions & 0 deletions docs/devlog/devlog_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Pocket V1 DevLog Call #{UPDATE_ME} Notes <!-- omit in toc -->

- **Date and Time**: <!-- UPDATE_ME -->
- **Location**: [Discord](https://discord.gg/pokt)
- **Duration**: 60 minutes
- [Recording](https://drive.google.com/drive/u/1/folders/1Ts6FHy3fcPjqjKl8grpd93L7DB1-N-LA)
- [Feedback and Discussion Form](https://app.sli.do/event/eF13JYg93rGq4pGLRnHLF5)

---

## Agenda <!-- omit in toc -->

- [Current Iteration 🗓️](#current-iteration-️)
- [Iteration Goals 🎯](#iteration-goals-)
- [Iteration Results ✅](#iteration-results-)
- [External Contributions ⭐](#external-contributions-)
- [Demo 💻](#demo-)
- [Upcoming Iteration 🗓️](#upcoming-iteration-️)
- [Feedback and Open Discussion 💡](#feedback-and-open-discussion-)
- [Q: ???](#q-)
- [Contribute to V1 🧑‍💻](#contribute-to-v1-)
- [About Pocket Network 💙](#about-pocket-network-)

---

## Current Iteration 🗓️

- Duration: <!-- UPDATE_ME -->
- [Backlog](https://github.com/orgs/pokt-network/projects/142/views/12?<!-- UPDATE_ME -->)

## Iteration Goals 🎯

- M1: PoS
- <!-- UPDATE_ME -->
- M2: DoS
- <!-- UPDATE_ME -->
- M3: RoS
- <!-- UPDATE_ME -->

## Iteration Results ✅

- Completed
- <!-- UPDATE_ME -->
- In Review
- <!-- UPDATE_ME -->
- In Progress
- <!-- UPDATE_ME -->

## External Contributions ⭐

- <!-- UPDATE_ME -->

---

## Demo 💻

---

## Upcoming Iteration 🗓️

- Duration: <!-- UPDATE_ME -->
- [Backlog Candidates](https://github.com/orgs/pokt-network/projects/142/views/12?<!-- UPDATE_ME -->)

---

## Feedback and Open Discussion 💡

[Feedback and Discussion Form](https://app.sli.do/event/2LFSdaBzJ4FPYANPFcGxC7/live/questions)

### Q: ???

A:

---

### Contribute to V1 🧑‍💻

V1 is an open source project that is open to external contributors. Find information about onboarding to the project, browse available bounties, or look for open issues in the linked resources below. For any questions about contributing, contact @jessicadaugherty

- [Configure Development Environment](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md)
- [Available Developer Bounties](https://app.dework.xyz/pokt-network/v1-protocol)
- [V1 Project Board](https://github.com/orgs/pokt-network/projects/142/views/12)
- [V1 Roadmap](https://github.com/pokt-network/pocket/blob/main/docs/roadmap/README.md#m1-pocket-pos-proof-of-stake)

## About Pocket Network 💙

Pocket Network is a blockchain data platform, built for applications, that uses cost-efficient economics to coordinate and distribute data at scale.

- [Website](https://pokt.network)
- [Documentation](https://docs.pokt.network)
- [Discord](https://discord.gg/pokt)
- [Twitter](https://twitter.com/POKTnetwork)

<!-- GITHUB_WIKI: devlog/template -->
Loading

0 comments on commit ecbb339

Please sign in to comment.