Skip to content

Conversation

@CBID2
Copy link
Contributor

@CBID2 CBID2 commented Aug 17, 2024

Author checklist (Completed by original Author)

  • Good fit for the Rocky Linux project? Title and Author Metatags inserted ?
  • If applicable, steps and instructions have been tested to work
  • Initial self-review to fix basic typos and grammar completed

Note

This PR adds a user guide about the Audio Sharing Decibels app in the GNOME section. I decided to create this as a replacement for PR #2249 to satisfy the requirements for RSOD.

Issue

Relates to #2161

Rocky Documentation checklist (Completed by Rocky team)

  • 1st Pass (Document is good fit for project and author checklist completed)
  • 2nd Pass (Technical Review - check for technical correctness)
  • 3rd Pass (Detailed Editorial Review and Peer Review)
  • Final approval (Final Review)

@CBID2 CBID2 mentioned this pull request Aug 17, 2024
5 tasks
@CBID2
Copy link
Contributor Author

CBID2 commented Aug 18, 2024

Ready for your review @wsoyinka


## Installation Process

Go to Flatub.com, type "Audio Sharing" in the search bar, and click on **Install**.
Copy link
Member

Choose a reason for hiding this comment

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

flathub.org not flatub.com

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Made the change @wsoyinka

@wsoyinka
Copy link
Member

Thank you for this @CBID2 !

To make this submission a bit more complete (and mergable) , please investigate and include the following:

  • Original screenshots different from the ones readily available on the app website
  • An example walk-through demonstrating playing a sample audio file/source from the system running the "audio sharing app". .e.g. a lengthy youtube video/audio
  • Corresponding simple example showing the reader how to connect to the stream from a separate device. Perhaps using VLC as a sample client on a different LAN device
  • Explicit instructions for how to punch a hole in the host firewall (e.g. firewalld) to make the stream accessible to other LAN systems/users

@CBID2
Copy link
Contributor Author

CBID2 commented Aug 19, 2024

Thank you for this @CBID2 !

To make this submission a bit more complete (and mergable) , please investigate and include the following:

  • Original screenshots different from the ones readily available on the app website

  • An example walk-through demonstrating playing a sample audio file/source from the system running the "audio sharing app". .e.g. a lengthy youtube video/audio

  • Corresponding simple example showing the reader how to connect to the stream from a separate device. Perhaps using VLC as a sample client on a different LAN device

  • Explicit instructions for how to punch a hole in the host firewall (e.g. firewalld) to make the stream accessible to other LAN systems/users

Hi @wsoyinka. I spoke to one of the admins of the Audio Sharing community server to get some ideas to implement your suggestions. He mentioned that there is nothing more to show except that users start the app and the QR code appears. With this in mind, I believe the best option would leave the guide as is.

@wsoyinka
Copy link
Member

Thank you for looking further into this @CBID2 !

Do you have a Rocky Linux desktop system yourself to try getting the app to work out of the box ?

If so perhaps you can document the procedure that you went through on the "app" side and the "client" side with your own screenshot screenshots.

@CBID2
Copy link
Contributor Author

CBID2 commented Aug 19, 2024

Thank you for looking further into this @CBID2 !

Do you have a Rocky Linux desktop system yourself to try getting the app to work out of the box ?

If so perhaps you can document the procedure that you went through on the "app" side and the "client" side with your own screenshot screenshots.

I don't have a Rocky Linux Desktop unfortunately @wsoyinka. My computer’s storage is full so I'm unable to set it up via Virtualbox.

@wsoyinka
Copy link
Member

Understood @CBID2 . No worries.

If you had a Rocky Linux system or similar to work/test with it would have been easy for to you to walk-through the procedure yourself and be able to authoritatively document it for others.

The apps works as intended but some assumptions are made about the end user's environment.

For example at minimum the default port 8554/TCP (rtsp-alt) port needs to be accessible/open on the system running the app so that LAN users/clients can connect to it. There is little utility if other devices cannot connect to the shared stream.

We'll see about merging your contribution as-is - with an aim to improving it in the future.

Hopefully, you'll be able to get a Rocky Linux VM running to assist with writing and testing any remaining RSOD contributions.

Many thanks again ❤️ !

@CBID2
Copy link
Contributor Author

CBID2 commented Aug 19, 2024

Understood @CBID2 . No worries.

If you had a Rocky Linux system or similar to work/test with it would have been easy for to you to walk-through the procedure yourself and be able to authoritatively document it for others.

The apps works as intended but some assumptions are made about the end user's environment.

For example at minimum the default port 8554/TCP (rtsp-alt) port needs to be accessible/open on the system running the app so that LAN users/clients can connect to it. There is little utility if other devices cannot connect to the shared stream.

We'll see about merging your contribution as-is - with an aim to improving it in the future.

Hopefully, you'll be able to get a Rocky Linux VM running to assist with writing and testing any remaining RSOD contributions.

Many thanks again ❤️ !

Thanks @wsoyinka. I also updated my proposal. I’d love your feedback on it

CBID2 added 2 commits August 23, 2024 23:11
Signed-off-by: Christine <shecoder30@gmail.com>
Signed-off-by: Christine <shecoder30@gmail.com>
@CBID2 CBID2 changed the title docs: add user guide on Audio Sharing app docs: add user guide on Decibels app Aug 23, 2024
CBID2 added 4 commits August 24, 2024 22:46
Signed-off-by: Christine <shecoder30@gmail.com>
Signed-off-by: Christine <shecoder30@gmail.com>
Signed-off-by: Christine <shecoder30@gmail.com>
… edits to the new user guide

Signed-off-by: Christine <shecoder30@gmail.com>
@github-actions
Copy link

Test results for 0ebe696:

Number of broken URLs: 0

URL,RESULT,FILENAME

@CBID2
Copy link
Contributor Author

CBID2 commented Aug 24, 2024

Hey @wsoyinka! :) I managed to get Rocky Linux to work on VirtualBox on a different computer. Sadly, the audio sharing app did not work there(the app's admin mentioned that the QR code does not work on virtual machines). So, to save time, I decided to replace the content with information about the Decibels app instead.

@CBID2 CBID2 requested a review from wsoyinka August 24, 2024 23:33
@CBID2
Copy link
Contributor Author

CBID2 commented Aug 27, 2024

Hey @wsoyinka. Are you going to review this?

@wsoyinka
Copy link
Member

Hey @wsoyinka. Are you going to review this?

Hey @CBID2 .... Anybody in the community can review contributions submitted by others if they have the spare cycles !
You (@CBID2 ) are welcome and encouraged to also review/test/improve the contributions submitted by others too :-)

I happen to have some cycles now and I just reviewed the "user guide on Decibels app" and it can be merged.

Many thanks for working on it and contributing it 😄 🥳 !!!

@CBID2
Copy link
Contributor Author

CBID2 commented Aug 27, 2024

Hey @wsoyinka. Are you going to review this?

Hey @CBID2 .... Anybody in the community can review contributions submitted by others if they have the spare cycles !

You (@CBID2 ) are welcome and encouraged to also review/test/improve the contributions submitted by others too :-)

I happen to have some cycles now and I just reviewed the "user guide on Decibels app" and it can be merged.

Many thanks for working on it and contributing it 😄 🥳 !!to it 😄 🥳 !!!

Thanks @wsoyinka!
I finished the user guide for the Decoder app, so now I'm going to submit my PR for it.

@wsoyinka wsoyinka merged commit 84f6f8b into rocky-linux:main Aug 27, 2024
@CBID2 CBID2 deleted the redo-of-RSOD-part-1 branch August 27, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants