Automattic / hostmgr

A tool for managing macOS VM hosts
Mozilla Public License 2.0
8 stars 3 forks source link

Broken links in README #101

Open williamtheaker opened 1 month ago

williamtheaker commented 1 month ago

The README has multiple references to https://github.com/Automattic/buildkite-ci, but I get a 404 when trying to view the repo since it's either private or no longer exists with that name.

AliSoftware commented 1 month ago

This is indeed a private repository, and the links reference some of our private IoC setup (Ansible playbook we use to deploy our machines, our private configuration…), so those are still useful to us to link to them in our README to connect the dots.

I guess we could consider adjusting the wording in the README to something along the lines of "using the Ansible playbook (for those who have access to that repo)" and the likes?


That being said, tbh, while I'm glad this project picked your interest and that we're happy to share if it ends up being useful to others, currently some of it is a bit specific to our infra—e.g. how our whole infra's stack is set up with Buildkite and our cache server for git mirrors and all, that drove some of our (potentially-hardcoded) decisions for this project's implementation. We didn't expect anyone other than us to be interested in using it (hence why the README assumes people using that project have access to our private IaC repo for example) 😄 — even though I'm happy to see it might be useful to others after all 🙂

So I just wanted to be transparent that I can't guarantee we'll have the bandwidth/priority in the team to spend too much time initiating the work to make sure that project (and its documentation) is flexible enough to be used in another context than ours (work priorities… 😓 ). i.e. while we'll welcome PRs that will go that go in that direction, doing so ourselves is not our current priority. Just wanted to be transparent and let you know, to manage your expectations on that front 😅