Buildkite documentation experience #263
I spent some time yesterday updating a @calibreapp test suite (Rails app) to break the job into a number of steps, rather than one big, long running
I ended up with tabs open to a lot of different buildkite repos, the docs site, and a chat window to @toolmantim.
I've been using all of this technology for a long time, but I found the process to be confusing, and a bit of a cycle of
I'm hopeful that by documenting some of the things that I went through, or faced, that it'll highlight some of the work that needs to be done to improve documentation.
A sample of the things I saw, did, or wondered
After that, there were some undocumented environment variables that had to be "punched through" the
In summary, here are the repos/pages that I looked at yesterday:
Apart from that, a bunch of docker docs, searches through random blogs and lots of Googling.
Links to other open issues
It'd be great if there was a guide/full recipe for a rails app (or node, python, whatever customers are using most). I really felt like I was on my own here, and it was one failure after the next… I know that's the nature of test suites, but I think some improvements to the existing docs and general standardisation would vastly improve the experience.