docs/sidebarNode.ts at main · oasisprotocol/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
import {SidebarsConfig} from '@docusaurus/plugin-content-docs';

export const sidebarNode: SidebarsConfig = {
  operators: [
    {
      type: 'doc',
      label: 'Overview',
      id: 'node/README',
    },
    {
      type: 'category',
      label: 'Network Information',
      description: 'These are the current parameters for the network.',
      collapsible: false,
      link: {
        type: 'doc',
        id: 'node/network/README',
      },
      items: [
        'node/network/mainnet',
        'node/network/testnet',
      ],
    },
    {
      type: 'category',
      label: 'Run Your Node',
      description:
        'The Oasis Network consists of several types of nodes, each serving distinct roles to maintain the functionality, security, and decentralization of the network.',
      collapsible: false,
      link: {
        type: 'doc',
        id: 'node/run-your-node/README',
      },
      items: [
        {
          type: 'category',
          label: 'Prerequisites',
          link: {
            type: 'generated-index',
            description:
              'This section lists hardware and software prerequisites for running an Oasis node.',
            slug: 'node/run-your-node/prerequisites',
          },
          items: [
            'node/run-your-node/prerequisites/hardware-recommendations',
            'node/run-your-node/prerequisites/cloud-providers',
            'node/run-your-node/prerequisites/stake-requirements',
            'node/run-your-node/prerequisites/oasis-node',
            'node/run-your-node/prerequisites/system-configuration',
            'node/run-your-node/prerequisites/set-up-tee',
          ],
        },
        'node/run-your-node/validator-node',
        'node/run-your-node/non-validator-node',
        'node/run-your-node/seed-node',
        'node/run-your-node/archive-node',
        'node/run-your-node/paratime-node',
        {
          type: 'category',
          label: 'ParaTime Client Node',
          link: {
            type: 'doc',
            id: 'node/run-your-node/paratime-client-node',
          },
          items: ['node/run-your-node/paratime-observer-node'],
        },
        'node/run-your-node/rofl-node',
        {
          type: 'category',
          label: 'Key Manager Node',
          link: {
            type: 'doc',
            id: 'node/run-your-node/keymanager-node/README',
          },
          items: [
            'node/run-your-node/keymanager-node/signing-key-manager-policy',
            'node/run-your-node/keymanager-node/key-manager-upgrade',
          ],
        },
        'node/run-your-node/sentry-node',
        {
          type: 'category',
          label: 'Maintenance',
          link: {
            type: 'generated-index',
            description:
              'This section provides documentation on how to maintain your Oasis node setup over long run.',
            slug: 'node/run-your-node/maintenance',
          },
          items: [
            'node/run-your-node/maintenance/wiping-node-state',
            'node/run-your-node/maintenance/handling-network-upgrades',
            'node/run-your-node/maintenance/adding-or-removing-nodes',
            'node/run-your-node/maintenance/refreshing-certificates',
            'node/run-your-node/maintenance/shutting-down-a-node',
          ],
        },
        {
          type: 'category',
          label: 'Advanced',
          link: {
            type: 'generated-index',
            description:
              'This section provides documentation on advanced usages of the Oasis node.',
            slug: 'node/run-your-node/advanced',
          },
          items: [
            'node/run-your-node/advanced/sync-node-using-state-sync',
            'node/run-your-node/advanced/pruning',
            'node/run-your-node/advanced/copy-state-from-one-node-to-the-other',
            'node/run-your-node/advanced/remote-signer',
          ],
        },
        'node/run-your-node/troubleshooting',
      ],
    },
    {
      type: 'doc',
      label: 'Web3 Gateway',
      id: 'node/web3',
    },
    {
      type: 'doc',
      label: 'gRPC Proxy',
      id: 'node/grpc',
    },
    {
      type: 'category',
      label: 'Reference',
      collapsible: true,
      link: {
        type: 'generated-index',
        description: 'Reference guide for node operators.',
        slug: 'node/reference',
      },
      items: [
        'node/reference/genesis-doc',
        {
          type: 'category',
          label: 'Network Upgrades',
          link: {
            type: 'generated-index',
            description:
              "This section provides information about previous upgrades.",
            slug: 'node/reference/upgrades',
          },
          items: [
            'node/reference/upgrades/damask-upgrade',
            'node/reference/upgrades/cobalt-upgrade',
            'node/reference/upgrades/mainnet-upgrade',
          ],
        },
        {
          type: 'category',
          label: 'Upgrade Logs',
          link: {
            type: 'generated-index',
            description:
              "This section provides upgrade logs.",
            slug: 'node/reference/upgrade-logs',
          },
          items: [
            {
              type: 'doc',
              id: 'node/reference/upgrade-logs/mainnet',
              label: 'Mainnet',
            },
            {
              type: 'doc',
              id: 'node/reference/upgrade-logs/testnet',
              label: 'Testnet',
            },
          ],
        },
      ],
    },
  ],
};