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

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

Closed
MaximUltimatum opened this issue Apr 6, 2024 · 9 comments
Closed
Labels
enhancement New feature or request

Comments

@MaximUltimatum
Copy link

MaximUltimatum commented Apr 6, 2024

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 MaximUltimatum added the enhancement New feature or request label Apr 6, 2024
@C-Fu
Copy link

C-Fu commented Apr 7, 2024

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

MaximUltimatum added a commit to MaximUltimatum/balena-sound that referenced this issue Apr 9, 2024
This commit should restore the balena-sound docs to working order
They have presently fallen into a state of code-rot due to no index.html
file at the root of the /docs directory
The landing page is rather bare-bones at the moment, but it can be enhanced later
once it is at least present.

Connects-to: balena-io-experimental#658
Change-type: patch
Signed-off-by: Maximilien McDermott [email protected]
@MaximUltimatum
Copy link
Author

@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.

@alanb128
Copy link
Contributor

alanb128 commented Apr 9, 2024

@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.

@maggie44
Copy link
Contributor

maggie44 commented Apr 15, 2024

@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/

@vipulgupta2048
Copy link
Member

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
Copy link
Member

vipulgupta2048 commented Apr 17, 2024

Update: Deployed docusaurus docs to staging. Should be live soon: #655 (comment)
Docs in Prod: https://balena-sound.pages.dev

@bam80
Copy link

bam80 commented Jul 27, 2024

Status?

@vipulgupta2048
Copy link
Member

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

@bam80
Copy link

bam80 commented Jul 29, 2024

So we can close this or anything left?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants