Updating S3 cache doc and adding infra examples #953
Conversation
jimsheldon
changed the title
|
|
||
| This example pipeline demonstrates cache usage across two stages. | ||
|
|
||
| ```mermaid |
|
Preview environment: https://hdh.pr.harness.io/pr-953 |
docs/continuous-integration/use-ci/caching-ci-data/saving-cache.md
Outdated
Show resolved
Hide resolved
docs/continuous-integration/use-ci/caching-ci-data/saving-cache.md
Outdated
Show resolved
Hide resolved
docs/continuous-integration/use-ci/caching-ci-data/saving-cache.md
Outdated
Show resolved
Hide resolved
docs/continuous-integration/use-ci/caching-ci-data/saving-cache.md
Outdated
Show resolved
Hide resolved
docs/continuous-integration/use-ci/caching-ci-data/saving-cache.md
Outdated
Show resolved
Hide resolved
docs/continuous-integration/use-ci/caching-ci-data/saving-cache.md
Outdated
Show resolved
Hide resolved
docs/continuous-integration/use-ci/caching-ci-data/saving-cache.md
Outdated
Show resolved
Hide resolved
docs/continuous-integration/use-ci/caching-ci-data/saving-cache.md
Outdated
Show resolved
Hide resolved
docs/continuous-integration/use-ci/caching-ci-data/saving-cache.md
Outdated
Show resolved
Hide resolved
|
|
||
| ::: | ||
|
|
||
| #### Linux/AMD64 |
There was a problem hiding this comment.
I would avoid going this far on heading levels. This would be better as just text in the body of the <details>.
I would argue the tabs are not necessary if you're going to put almost all (or all) of the content in the accordions. I would just use accordions then. you might also consider using tabs for "Single stage" and "multi stage". Then use an accordion for each build infra example.
There was a problem hiding this comment.
No problem removing the heading.
There will be more than Linux/AMD64, we will probably have Linux/ARM64, Windows/AMD64, Mac/ARM64 and so on.
Linux and Mac might be identical, but I expect Windows to be different. Since we are already inside infrastructure tabs at this level, I am struggling with the best way to show this. Do users really need to see examples for every combination of OS/architecture? We also need to figure out how to show other languages than node.js... We can't have examples for every permutation.
There was a problem hiding this comment.
Providing an example for every permutation is probably not realistic - It would slow down docs work a lot. I would consider the real difference between them. Are they truly completely different or is it something like "sudo" vs "run as admin"?
There was a problem hiding this comment.
And also, is the value in showing the different languages or in showing the different platforms?
|
Preview environment: https://hdh.pr.harness.io/pr-953 |
DO NOT MERGE! This is a work in progress
Harness Developer Pull Request
Thanks for helping us make the Developer Hub better. The PR will be looked at
by the maintainers.
What Type of PR is This?
If tied to an Issue, list the Issue(s) here:
House Keeping
Some items to keep track of. Screen shots of changes are optional but would help the maintainers review quicker.
Updating the S3 cache doc with updated information and infra examples