Adding a new docs chapter with example walkthroughs

[rklonner]

Currently "only" the Overview chapter is referring to examples what can be done with ArgoCD Diff Preview by linking to 3 example PRs.

If one filters further on available branches of the argocd-diff-preview repo starting with "example-" users find more use cases and can look at the branches.

I think it would make sense to add a chapter "Examples" or "Use cases" in the docs to show and explain a bit more in detail what happens for a broader audience and easier onboarding. We could do this in a scheme where also the actual commands (like you did in the Demo) and cli parameters are listed and outlined for better understanding "e.g. file_regex" and other possible examples (e.g. Distributed repos, argocd manifest refactoring )

---

Use cases 1 - Helm example internal chart

git clone https://github.com/dag-andersen/argocd-diff-preview base-branch --depth 1 -q 
git clone https://github.com/dag-andersen/argocd-diff-preview target-branch --depth 1 -q -b helm-example-3

docker run \
   --network host \
   -v /var/run/docker.sock:/var/run/docker.sock \
   -v $(pwd)/output:/output \
   -v $(pwd)/base-branch:/base-branch \
   -v $(pwd)/target-branch:/target-branch \
   -e TARGET_BRANCH=helm-example-3 \
   -e REPO=dag-andersen/argocd-diff-preview \
   dagandersen/argocd-diff-preview:v0.1.19

asset: image of the diff or even the html rendered diff

Use case 2 - ...

What do you think?

[dag-andersen]

What do you think?

@rklonner

I think it sounds like a good idea to have a section with examples and use cases!

I don't know if it is better to link to the pull request, or if it is better to show the commands for producing it locally (like you wrote in this issue).

I think both options sound good. But maybe for simplicity it is better to link to a PR instead of writing out the commands, because then I would need to rerun the use case example every time I make a release to make sure I didn't break anything. If they stay at pull-request links i always know they are up to date, because i rebase them on every new release.

What do you think?