Skip to content

Commit

Permalink
Added test file for documentation, added feedback on proposal
Browse files Browse the repository at this point in the history
  • Loading branch information
DominicF96 committed Apr 12, 2024
1 parent 977f80c commit bd77a28
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 3 deletions.
20 changes: 19 additions & 1 deletion docs/proposals/ops-product-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@

This document is a proposal for syncing the OPS and Product teams. The goal is to ensure that the metadata of chains supported by Pinax products is up-to-date and accurate. This process is crucial in ensuring that the product team has the necessary information to maintain the products.

> WIP: This document is a work in progress and is subject to change.
>
> exact schedule for blockchain to be deployed exists
There are different sources
Jonathan prioritizes chains on 'easy' wins
YAML/JSON doesn't mean its ready
>
> -->> Once a blockchain is ready, DNS record (another yaml file in repo) <<--
Doesn't mean blockchain is backuped, stable, etc. Maybe OK for use by The Graph.
>
> Automation might not be as straightforward
>
> Requirements for The Graph are different than requirements from public use.
>
> Fully operationnal chains tracked in Google Sheets
>
> Sajjad handles backups
## Background

The OPS team maintains a private list (in a YAML file in the OPS Github organization) of chains supported or to-be-supported by Pinax. This list needs to be maintained as it triggers a series of automations on the ops side.
Expand Down Expand Up @@ -85,4 +103,4 @@ The OPS team will maintain the private list as they do now and a GitHub Action,

The Product team can then leverage the public endpoint and Github Actions on their side too.

Depending on the data the OPs team can provide and if The Graph accepts it, the Product team could work on an automated alternative to the current manual process of updating the Notion page.
Depending on the data the OPs team can provide and if The Graph accepts it, the Product team could work on an automated alternative to the current manual process of updating the Notion page.
2 changes: 1 addition & 1 deletion src/types/graph.types.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This file is auto-generated on pre-commit to avoid maintaining it.
// Do not modify manually as it will be overwritten.
// Last generation on 4/10/2024, 5:50:16 PM.
// Last generation on 4/12/2024, 11:45:52 AM.
export type GraphID =
| 'arbitrum-one'
| 'arbitrum-sepolia'
Expand Down
2 changes: 1 addition & 1 deletion src/types/pinax.types.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This file is auto-generated on pre-commit to avoid maintaining it / circular dependencies.
// Do not modify manually as it will be overwritten.
// Last generation on 4/10/2024, 5:50:16 PM.
// Last generation on 4/12/2024, 11:45:52 AM.
export type PinaxID =
| 'arbgoerli'
| 'arbsepolia'
Expand Down
Empty file.

0 comments on commit bd77a28

Please sign in to comment.