Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise Siren documentation #6553

Open
wants to merge 21 commits into
base: unstable
Choose a base branch
from
Open

Conversation

chong-he
Copy link
Member

Proposed Changes

Update Siren documentation in Lighthouse book. There are quite some changes compared to the original doc so I will leave some comments to sections to highlight the change. I have also combined Configuration and Installation together as they are quite related to start Siren.

book/src/ui-configuration.md Show resolved Hide resolved
book/src/ui-configuration.md Outdated Show resolved Hide resolved
@chong-he chong-he added ready-for-review The code is ready for review docs Documentation labels Oct 31, 2024
Copy link
Member

@antondlr antondlr left a comment

Choose a reason for hiding this comment

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

if you can wait a couple days, I can make suggestion commits for the items I stipulated (https instead of ssh).
and/or if you're confused we can have a call to discuss it, so I can explain.

book/src/ui-configuration.md Outdated Show resolved Hide resolved
book/src/ui-configuration.md Show resolved Hide resolved
book/src/ui-authentication.md Outdated Show resolved Hide resolved
book/src/ui-configuration.md Outdated Show resolved Hide resolved
book/src/ui-configuration.md Outdated Show resolved Hide resolved
book/src/ui-configuration.md Outdated Show resolved Hide resolved
@chong-he chong-he added waiting-on-author The reviewer has suggested changes and awaits thier implementation. and removed ready-for-review The code is ready for review labels Nov 4, 2024
@chong-he chong-he added ready-for-review The code is ready for review and removed waiting-on-author The reviewer has suggested changes and awaits thier implementation. labels Nov 18, 2024
@chong-he chong-he requested a review from antondlr November 18, 2024 07:03
Copy link
Member

@antondlr antondlr left a comment

Choose a reason for hiding this comment

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

lgtm!

@chong-he chong-he added waiting-on-author The reviewer has suggested changes and awaits thier implementation. and removed ready-for-review The code is ready for review labels Nov 22, 2024
@chong-he
Copy link
Member Author

As discussed with @antondlr, waiting for some testing and a final check before this is complete

@michaelsproul
Copy link
Member

Almost ready to merge this one?

@michaelsproul michaelsproul added the v6.1.0 New release c. Q1 2025 label Dec 2, 2024
@chong-he
Copy link
Member Author

chong-he commented Dec 3, 2024

Almost ready to merge this one?

Got some tests and final checking pending, will try to get it done soon

@chong-he chong-he requested a review from antondlr December 5, 2024 13:01
@chong-he chong-he added ready-for-review The code is ready for review and removed waiting-on-author The reviewer has suggested changes and awaits thier implementation. labels Dec 6, 2024
Copy link
Member

@antondlr antondlr left a comment

Choose a reason for hiding this comment

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

let's go!!

there's some stuff that will need rephrasing after magick93's pr gets merged but let's leave that out of scope for now

@chong-he chong-he added ready-for-merge This PR is ready to merge. and removed ready-for-review The code is ready for review labels Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation ready-for-merge This PR is ready to merge. v6.1.0 New release c. Q1 2025
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants