balena-sound icon indicating copy to clipboard operation
balena-sound copied to clipboard

Balena-sound docs are down, and an offer to help as a maintainer

Open MaximUltimatum opened this issue 10 months ago • 6 comments

Hello! I have noticed that as of today, April 6th, the docs for this project appear to be down. https://balena-labs-projects.github.io/balena-sound/ The last tagged version of this project was in 2022, by @maggie44

I dearly love this project. It has provided an affordable way to enjoy music as a family for me and my loved ones for several years now, and been a feature of gatherings of family and friends in my life.

Would an extra maintainer for this project be helpful? I'm thankful for what balena has made available to the community, and would be happy to give back in the form of development help.

I've been a microcontroller hobbyist for several years, and a Kubernetes hobbyist as well.

If an extra maintainer would be helpful to allow this project to continue to thrive, what would be most helpful? I can help triage issues, just try and stay on top of updates to the docs, or work on resolving old outstanding Issues and PRs. I'm happy to do any and all of those - Just let me know what would be most helpful.

@-ing existing folks who look like maintainers. @maggie44 @thgreasi @alanb128

MaximUltimatum avatar Apr 06 '24 13:04 MaximUltimatum

just fork and move on, they don't seem to care about this. Doesn't seem to be in a working state atm anyways.

C-Fu avatar Apr 07 '24 13:04 C-Fu

@vipulgupta2048 I was reviewing #654 and #655 and thought they might be related to the documentation suddenly breaking. I can close #659 if you have a better solution? It was just meant as a patch to get the docs back up and running, since I wasn't sure why they broke in the first place.

MaximUltimatum avatar Apr 09 '24 18:04 MaximUltimatum

@MaximUltimatum we're looking into some options to restore the documentation but it may take a little longer. Thanks for your patch, we'll let you know if we have a better solution.

alanb128 avatar Apr 09 '24 20:04 alanb128

@MaximUltimatum, looks like balena moved the repo in to a new org. Change any references in the README to the docs from the old org:

https://balena-labs-projects.github.io/balena-sound/

to the new org:

https://balena-io-experimental.github.io/balena-sound/

maggie44 avatar Apr 15 '24 14:04 maggie44

Hello, I didn't want to ping before they went live but we are in the process of moving the docs to docusaurus at the moment. The docs did break because of the move to a new org. We also found that the current docs were built using Landr, and a migration to docusaurus was due. They are currently blocked due to a configuration issue that will soon be resolved. I already have them running locally on my system and will deploy them to production.

Screenshot 2024-04-12 at 11 24 36 PM

vipulgupta2048 avatar Apr 16 '24 04:04 vipulgupta2048

Update: Deployed docusaurus docs to staging. Should be live soon: https://github.com/balena-io-experimental/balena-sound/pull/655#issuecomment-2060865643 Docs in Prod: https://balena-sound.pages.dev

vipulgupta2048 avatar Apr 17 '24 09:04 vipulgupta2048

Status?

bam80 avatar Jul 27 '24 14:07 bam80

@bam80 Since April 17, the docs have been online here: https://balena-sound.pages.dev/

vipulgupta2048 avatar Jul 29 '24 18:07 vipulgupta2048

So we can close this or anything left?

bam80 avatar Jul 29 '24 18:07 bam80