[docs] Relayminer config documentation

[red-0ne]

Summary

AI Summary

Summary generated by Reviewpad on 04 Jan 24 23:45 UTC

This pull request includes the addition of a new file, category.json. The added file contains a JSON object with the properties: "label" set to "Configs", "position" set to 5, and "link" set to an object with "type" as "generated-index" and "description" as "Poktroll Configs".

Issue

• [☂️ Documentation] Umbrella ticket to update all-the-docs #159

Type of change

Select one or more:

• New feature, functionality or library
• Bug fix
• Code health or cleanup
• Documentation
• Other (specify)

[Olshansk]

Shoud be g2g after a round of changes and cross-referencing #284, but am a big fan of the shape it's taking!

[Olshansk]

I started making a few edits to the chart so the yaml <-> protobuf conversion is clearer. Might need a few more tweaks but lmk wyt

flowchart LR

    subgraph "Supplier Actor (On-Chain)"
        subgraph "SupplierServiceConfig (protobuf)"
            subgraph svc1["Service1 (protobuf)"]
                svc1Id[Service1.Id]
                subgraph SupplierEndpoint
                    EP1[Endpoint1]
                    EP2[Endpoint2]
                end
            end
            subgraph svc2[Service2]
                svc2Id[Service2.Id]
            end
        end
    end

    subgraph "RelayMiner Operator (Off-Chain)"
        subgraph "DevOps Operator Configs (yaml)"
            subgraph svc1Config["Service1 Config (yaml)"]
                svc1IdConfig[name=Service1.Id]-->svc1Id
            subgraph Hosts
                H1[Endpoint1.Host]-->EP1
                H2[Endpoint2.Host]-->EP2
            end
        end
        subgraph svc2Config[Service2 Config]
            svc2IdConfig[Service2.Id]
        end
    end
  end

  svc2Config-->svc2

Loading

[Olshansk]

@red-0ne I didn't mean to suggest that I "finished" the diagram but just wanted to provide a starting point.

I want to get this PR in, so here's what I think we should do:

1. With what we have, is name still relevant given that we renamed it to proxy_name or was that a different name?
2. Merge in the what we have as "good enough" but remember to "update and improve" when something comes up.

[Olshansk]

Approving this but PTAL at the following before merging: #288 (comment)

[Olshansk]