Siren Docs Upgrade #5979

rickimoore · 2024-06-21T11:56:01Z

Issue Addressed

Proposed Changes

Update siren docs

Additional Info

Added info about sirens new structure

michaelsproul · 2024-06-24T11:45:04Z

This should probably target unstable even if we want it in v5.2.1, because the book is built from unstable, not stable

book/src/ui-authentication.md

chong-he

There are some errors with the markdown linter. Run mdlint from the Lighthouse root depository and it should automatically resolve some of the errors. Some others may need manual editing though

book/src/ui-installation.md

book/src/ui-usage.md

chong-he

Looks good now. I just have a comment on the exiting without updating the withdrawal credentials. I wonder if it is worth to open an issue about it? There probably aren't that many users haven't updated their credentials, but there are some that still haven't. It could also be useful in testnet where the withdrawal credentials are of 0x00 type.

chong-he · 2024-07-04T00:52:56Z

book/src/ui-faqs.md

@@ -27,7 +27,7 @@ In the absence of a VPN, an alternative approach involves utilizing an SSH tunne

 ## 6. How do I connect Siren to Lighthouse via a ssh tunnel?

-If you would like to access Siren beyond the local network (i.e across the internet), we recommend using an SSH tunnel. This requires a tunnel for 3 ports: `80` (assuming the port is unchanged as per the [installation guide](./ui-installation.md#docker-recommended)), `5052` (for beacon node) and `5062` (for validator client). You can use the command below to perform SSH tunneling:
+If you would like to access Siren beyond the local network (i.e across the internet), we recommend using an SSH tunnel. This requires a tunnel for 3 ports: `80` (assuming the port is unchanged as per the [installation guide](./ui-installation.md#building-from-docker-recommended)), `5052` (for beacon node) and `5062` (for validator client). You can use the command below to perform SSH tunneling:


With the new release, do we need to change the port 80? The doc mentions it is on 3443 now

@antondlr can you help here?

Yes. I'm gonna scrap the whole ssh tunnel idea, we no longer need that.
Siren is now supposed to run alongside your BN/VC, exposing a webapp that can be accessed from any browser.

Should we remove FAQ no. 6 about ssh tunnel if it is no longer relevant?

book/src/ui-usage.md

chong-he · 2024-07-17T06:07:22Z

@antondlr , if you run mdlint from the root depository, it should fix most/all erros in the markdown linter

chong-he

Did another testing and this comment is from a user perspective:

How does a user ssh into a node and run Siren? I tested ssh into a node and started Siren with the flag --net=host (got from @antondlr) , Siren started in the terminal, but I can't access SIren via the web browser of the client (I can access via the web browser of the server by just typing localhost)

book/src/ui-installation.md

AgeManning · 2024-07-21T23:00:55Z

@Mergifyio queue

mergify · 2024-07-21T23:01:04Z

queue

🛑 The pull request has been removed from the queue `default`

The queue conditions cannot be satisfied due to failing checks.

You can take a look at Queue: Embarked in merge queue check runs for more details.

In case of a failure due to a flaky test, you should first retrigger the CI.
Then, re-embark the pull request into the merge queue by posting the comment
@mergifyio refresh on the pull request.

AgeManning · 2024-07-23T04:07:47Z

@Mergifyio refresh

mergify · 2024-07-23T04:08:10Z

refresh

✅ Pull request refreshed

AgeManning · 2024-07-23T05:59:39Z

@rickimoore - I think you need to merge the latest unstable

Co-authored-by: chonghe <[email protected]>

AgeManning · 2024-07-24T03:55:46Z

@Mergifyio queue

mergify · 2024-07-24T03:55:52Z

queue

✅ The pull request has been merged automatically

The pull request has been merged automatically at 9a53f4d

rickimoore changed the title ~~fix: removed unused sections~~ Siren Docs Upgrade Jun 21, 2024

antondlr changed the base branch from unstable to release-v5.2.1 June 24, 2024 10:43

antondlr added the v5.2.1 Patch release for v5.2.0 label Jun 24, 2024

michaelsproul changed the base branch from release-v5.2.1 to unstable June 24, 2024 11:45

michaelsproul added the waiting-on-author The reviewer has suggested changes and awaits thier implementation. label Jun 26, 2024

chong-he reviewed Jun 27, 2024

View reviewed changes

book/src/ui-authentication.md Show resolved Hide resolved

chong-he reviewed Jul 2, 2024

View reviewed changes

rickimoore requested a review from chong-he July 3, 2024 12:58

chong-he reviewed Jul 4, 2024

View reviewed changes

rickimoore requested a review from chong-he July 17, 2024 10:25

chong-he reviewed Jul 17, 2024

View reviewed changes

book/src/ui-installation.md Outdated Show resolved Hide resolved

rickimoore requested a review from antondlr July 17, 2024 14:51

chong-he added ready-for-review The code is ready for review docs Documentation and removed waiting-on-author The reviewer has suggested changes and awaits thier implementation. v5.2.1 Patch release for v5.2.0 labels Jul 17, 2024

AgeManning approved these changes Jul 21, 2024

View reviewed changes

mergify bot added a commit that referenced this pull request Jul 21, 2024

Merge of #5979

b28dbe3

mergify bot mentioned this pull request Jul 21, 2024

merge queue: embarking unstable (256f012) and #5979 together #6141

Closed

5 tasks

rickimoore and others added 4 commits July 23, 2024 11:08

fix: removed unused sections

73abfca

Update book/src/ui-authentication.md

ecc1dea

Co-authored-by: chonghe <[email protected]>

feat: added more information about features and screenshots

1fba513

Update book/src/ui-usage.md

8ddc2b6

Co-authored-by: chonghe <[email protected]>

rickimoore and others added 17 commits July 23, 2024 11:08

Update book/src/ui-usage.md

9a88bd1

Co-authored-by: chonghe <[email protected]>

Update book/src/ui-usage.md

bda267e

Co-authored-by: chonghe <[email protected]>

Update book/src/ui-usage.md

a3ad34e

Co-authored-by: chonghe <[email protected]>

Update book/src/ui-usage.md

3b1e58b

Co-authored-by: chonghe <[email protected]>

Update book/src/ui-installation.md

d1e2300

Co-authored-by: chonghe <[email protected]>

Update book/src/ui-usage.md

1909842

Co-authored-by: chonghe <[email protected]>

Update ui-usage.md

6e3b60b

Update ui-faqs.md

10caaf9

fix: lint fixes

76b9693

Update ui-usage.md

32c80d9

Update book/src/ui-usage.md

7ea0e26

Co-authored-by: chonghe <[email protected]>

Update book/src/ui-usage.md

5cc58bc

Co-authored-by: chonghe <[email protected]>

Update book/src/ui-usage.md

e676646

Co-authored-by: chonghe <[email protected]>

add siren's ssl certificate usage to book

7d8e481

update ui docs

3fb540a

lint fixes

d56a59e

Update book/src/ui-installation.md

331e22f

Co-authored-by: chonghe <[email protected]>

rickimoore force-pushed the siren-docs-upgrade branch from b74761b to 331e22f Compare July 23, 2024 09:09

mergify bot added a commit that referenced this pull request Jul 24, 2024

Merge of #5979

09b3f3e

mergify bot mentioned this pull request Jul 24, 2024

merge queue: embarking unstable (10445f3) and #5979 together #6160

Closed

5 tasks

mergify bot merged commit 9a53f4d into sigp:unstable Jul 24, 2024
29 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Siren Docs Upgrade #5979

Siren Docs Upgrade #5979

rickimoore commented Jun 21, 2024

michaelsproul commented Jun 24, 2024

chong-he left a comment

chong-he left a comment

chong-he Jul 4, 2024

rickimoore Jul 4, 2024

antondlr Jul 5, 2024

chong-he Jul 8, 2024

chong-he commented Jul 17, 2024

chong-he left a comment •

edited

Loading

AgeManning commented Jul 21, 2024

mergify bot commented Jul 21, 2024 •

edited

Loading

AgeManning commented Jul 23, 2024

mergify bot commented Jul 23, 2024

AgeManning commented Jul 23, 2024

AgeManning commented Jul 24, 2024

mergify bot commented Jul 24, 2024 •

edited

Loading

Siren Docs Upgrade #5979

Siren Docs Upgrade #5979

Conversation

rickimoore commented Jun 21, 2024

Issue Addressed

Proposed Changes

Additional Info

michaelsproul commented Jun 24, 2024

chong-he left a comment

Choose a reason for hiding this comment

chong-he left a comment

Choose a reason for hiding this comment

chong-he Jul 4, 2024

Choose a reason for hiding this comment

rickimoore Jul 4, 2024

Choose a reason for hiding this comment

antondlr Jul 5, 2024

Choose a reason for hiding this comment

chong-he Jul 8, 2024

Choose a reason for hiding this comment

chong-he commented Jul 17, 2024

chong-he left a comment • edited Loading

Choose a reason for hiding this comment

AgeManning commented Jul 21, 2024

mergify bot commented Jul 21, 2024 • edited Loading

🛑 The pull request has been removed from the queue default

AgeManning commented Jul 23, 2024

mergify bot commented Jul 23, 2024

✅ Pull request refreshed

AgeManning commented Jul 23, 2024

AgeManning commented Jul 24, 2024

mergify bot commented Jul 24, 2024 • edited Loading

✅ The pull request has been merged automatically

chong-he left a comment •

edited

Loading

mergify bot commented Jul 21, 2024 •

edited

Loading

🛑 The pull request has been removed from the queue `default`

mergify bot commented Jul 24, 2024 •

edited

Loading