Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve README with links and updates (#538)
- Argo Rollouts also [uses this repo](https://github.com/argoproj/argo-rollouts/blob/db5e3b2a8ffd9aef8c1e2026985c906fc9eef068/ui/package.json#L11) - update Yarn link to Yarn v1 / Classic, as those docs are quite different from the current v4 docs - same for Storybook v6 vs current v7 / v8 beta - say "Storybook" with an in-line link, not just a link. it is referred to as "Storybook" - see also k8s style guide on [links](https://kubernetes.io/docs/contribute/style/style-guide/#links) - simplify "Build & Run" section a bit - changing dirs to the repo you just cloned is implied. we don't say how to clone or fork, so leave this out too - also you don't have to name your local dir `argo-ui` - "`yarn install` to install dependencies" is redundant - a bit simpler and more direct, [per k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) - could make it even simpler, but left it close to the same style for now - fix some `markdownlint` etc issues in the "Local Development" section - specify syntax in code blocks - `yalc` should be in backticks as it's a command Signed-off-by: Anton Gilgur <[email protected]>
- Loading branch information