Skip to content

Commit

Permalink
docs: improve README with links and updates (#538)
Browse files Browse the repository at this point in the history
- 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
Anton Gilgur authored Feb 13, 2024
1 parent ce4b63d commit 3ac11b1
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,33 @@

<img src="https://github.com/argoproj/argo-ui/blob/master/src/assets/images/logo.png?raw=true" alt="Argo Image" height="200px">

Set of React components used by [Argo Workflows](https://github.com/argoproj/argo-workflows) and [Argo CD](https://github.com/argoproj/argo-cd).
Set of React components used by [Argo Workflows](https://github.com/argoproj/argo-workflows), [Argo CD](https://github.com/argoproj/argo-cd), and [Argo Rollouts](https://github.com/argoproj/argo-rollouts).

## Build & Run

1. Install Toolset: [NodeJS](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com)
1. Install Dependencies: From your command line, navigate to the argo-ui directory and run `yarn install` to install dependencies.
1. Run: `yarn start` - starts https://storybook.js.org/ dev server
1. Install Toolset: [NodeJS](https://nodejs.org/en/download/) and [Yarn v1](https://classic.yarnpkg.com/en/docs)
1. Install Dependencies: run `yarn install`
1. Run: `yarn start` - starts the [Storybook v6](https://storybook.js.org/docs/6.5/get-started/install) dev server

## Local Development

To test your changes locally against Argo CD or another Argo project, we recommend using [yalc](https://github.com/wclr/yalc).
To test your changes locally against Argo CD or another Argo project, we recommend using [`yalc`](https://github.com/wclr/yalc).

First, install `yalc`:

```
```sh
npm i -g yalc
```

Next, in your local `argo-ui` directory, run

```
```sh
yalc publish
```

Finally, in your local `argo-cd/ui` directory, run

```
```sh
yalc add argo-ui
```

Expand Down

0 comments on commit 3ac11b1

Please sign in to comment.