Skip to content

[Documentation] Improve infrastructure documentation and lings #784

@Olshansk

Description

@Olshansk

Objective

Make infrastructure-related documentation accessible and increase visibility into DevNet

Origin Document

Screenshot 2023-05-23 at 2 42 59 PM

Links:

  1. https://www.notion.so/pocketnetwork/How-to-DevNet-ff1598f27efe44c09f34e2aa0051f0dd
  2. https://github.com/pokt-network/protocol-infra
  3. https://www.notion.so/pocketnetwork/V1-networks-7d95c10c930c45c3823c871f21d44fca?pvs=4

Goals

  • Increase visibility into the ongoing work in DevNet
  • Make infrastructure-related dependencies and documentation as accessible as that related to protocol development

Deliverable

  • Make sure all the links above are our main DEVELOPMENT readme
  • Leave a TODO to productionize them as READMEs in the future (add a comment in the docs)
  • Point this out explicitly in the internal new-hire guide
  • Link to our DevNet grafana dashboard directly in the main README of pocket-core/pocket
  • Bonus/optional: productionizing the notion docs to markdown in the repo

Non-goals / Non-deliverables

  • Changing the existing notion docs

General issue deliverables

  • Update the appropriate CHANGELOG(s)
  • Update any relevant local/global README(s)

Creator: @Olshansk
Co-Owners: @okdas @dylanlott

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationinfraCore infrastructure - not protocol related

Type

No type

Projects

Status

In Progress

Relationships

None yet

Development

No branches or pull requests

Issue actions