Skip to content
This repository was archived by the owner on Jul 8, 2025. It is now read-only.

docs(walrus-sites): Template for importing operators from operators.json source or truth#293

Closed
vlegakis wants to merge 10 commits intomainfrom
templates
Closed

docs(walrus-sites): Template for importing operators from operators.json source or truth#293
vlegakis wants to merge 10 commits intomainfrom
templates

Conversation

@vlegakis
Copy link
Contributor

No description provided.

@vlegakis vlegakis self-assigned this Mar 13, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2025

PR Preview Action v1.6.0
Preview removed because the pull request was closed.
2025-03-25 12:41 UTC

@vlegakis vlegakis changed the title Templates JSON docs(walrus-sites): Template for importing operators from operators.json source or truth Mar 13, 2025
@vlegakis vlegakis mentioned this pull request Mar 13, 2025
@vlegakis vlegakis requested review from mlegner and nikos-terzo March 13, 2025 14:51
@vlegakis vlegakis marked this pull request as ready for review March 13, 2025 14:52
Copy link
Collaborator

@mlegner mlegner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much, @vlegakis, I love it!

Two questions and one suggestion from my side.

Comment on lines +113 to +114
{{ #aggregators }}
{{ /aggregators }}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two questions:

  1. Can we sort them in some way? It seems they are sorted alphabetically by default, but I'd prefer to have those with HTTPS first and those with bare IP addresses last.
  2. Can we somehow indicate additional info like whether they have a cache?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: Can we add something like the following above the "Public aggregators" heading?

```admonish tip
The following list of aggregators and publishers is also available in
[JSON format](../assets/operators.json).
```

Copy link

@nikos-terzo nikos-terzo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Having operators as a json file, can help with programmability.


[preprocessor.templates]
command = "mdbook-templates"
path = "docs/assets/operators.json"
Copy link

@nikos-terzo nikos-terzo Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current operators refer to testnet-operators. We should find a way to differentiate them from future mainnet ones.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, good point. Maybe something like

{
  "mainnet": {
    "aggregators": {
      "..."
    },
    "publishers": {
      "..."
    }
  },
  "testnet": {
    "..."
  }
}

@mlegner
Copy link
Collaborator

mlegner commented Mar 25, 2025

@vlegakis I'm closing this as we now have this in the main repository.

@mlegner mlegner closed this Mar 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants