docs
docs copied to clipboard
buildkite
Hosted Agents Cache Volume Docs
This introduces the new cache volumes feature for hosted agents. We currently support two types of caching for hosted agents: path based caching, where a path within a build is restored from a cache volume, and git mirror caching where a git repository is cached within a volume to avoid pulling the entire repository again.
I was also thinking it might be good to put in a section on 'Managing Cache Volumes' (or similar), referring to the Cache Volumes index page and the Delete functionality in that UI so that we can clarify what its doing + expected behaviour there
I think I'll leave this out of the first cut.
Thanks @matthewborden for your contribution @l-suzuki for your review 🎉
I'll give this a brief tech writer review now. The writing style guide should point out that only product names should use title case (i.e. as Proper Nouns), but product features should not (i.e. they're just common nouns). If you could suggest any changes to make this existing guidance clearer, please let me know. (Maybe move/promote the first line of the note about how product features should be handled a little higher?)
I strongly suspect "cache volumes" is a product feature and not a standalone 'named' product sold by Buildkite or any other 3rd-party software company. Therefore, this should be written as a common noun. I'll make these updates directly to this PR if that's OK?
If I don't finish my review today, I'll continue tomorrow morning
I strongly suspect "cache volumes" is a product feature and not a standalone 'named' product sold by Buildkite or any other 3rd-party software company. Therefore, this should be written as a common noun. I'll make these updates directly to this PR if that's OK?
Thanks!
Just going to implement some changes directly to this PR @matthewborden to address a couple of minor points:
- Reduce the overuse of 'Cache volumes' starting successive sentences.
- Streamline a few sentences.
- Implement a few clarifications.
Post my updates, I've also made some comments on existing text I have some queries over, mainly to do with some terms (possibly jargon) that aren't obvious.
Otherwise, I'm happy to approve this PR and ready for you to merge it if you need to get this published 'as is' asap.
Go for it