Skip to content

Commit fc4a6d8

Browse files
authored
Merge pull request #3790 from dlabrecq/readme
Update README
2 parents 4aabb26 + f1dd93b commit fc4a6d8

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ https://stage.foo.redhat.com:1337/beta/openshift/cost-management
6464

6565
### Running Koku UI with local Cloud Services Backend
6666

67-
See https://github.com/RedHatInsights/chrome-service-backend/blob/main/docs/cloud-services-config.md#serving-files-locally
67+
Refer to the [serving files locally][serving-files-locally] section of cloud services config for more details
6868

6969
1. Serve files locally from Cloud Services Backend repo
7070
```
@@ -78,7 +78,7 @@ npm start:csb
7878

7979
### Running Koku UI with local Koku microfrontend (MFE)
8080

81-
See https://github.com/project-koku/koku-ui-mfe
81+
Refer to the [koku-ui-mfe README][koku-ui-mfe-readme] for more details
8282

8383
1. Start development server in Koku MFE repo
8484
```
@@ -92,8 +92,7 @@ npm start:mfe
9292

9393
### Running Koku UI with local Koku microfrontend (MFE) and Cloud Services Backend
9494

95-
See https://github.com/RedHatInsights/chrome-service-backend/blob/main/docs/cloud-services-config.md#serving-files-locally
96-
and https://github.com/project-koku/koku-ui-mfe
95+
Refer to the [serving files locally][serving-files-locally] section of cloud services config and the [koku-ui README][koku-ui-mfe-readme] for more details
9796

9897
1. Serve files locally from Cloud Services Backend repo
9998
```
@@ -130,9 +129,10 @@ http://localhost:8002/beta/openshift/cost-management
130129
```
131130

132131
#### Koku API
133-
Refer to the project [README][koku-readme] for prerequisites
134132

135-
1. Setup & run Koku API (see project [README][koku-readme] for more details)
133+
Refer to the [koku README][koku-readme] for more details
134+
135+
1. Setup & run Koku API
136136
```
137137
git clone git@github.com:project-koku/koku.git
138138
cd [KOKU_GIT_REPO]
@@ -164,7 +164,7 @@ exit
164164

165165
## Running local instances of Settings Frontend & Koku API
166166

167-
Follow the [steps](#koku-api) to run a local Koku API instance
167+
Follow the koku API [steps](#koku-api) to run a local Koku API instance
168168

169169
1. Clone the Settings Frontend repository and install dependencies
170170
```
@@ -195,13 +195,14 @@ http://localhost:1337/beta/settings/applications/cost-management
195195
This [RELEASE][release-doc] doc describes how to release Koku UI to each staging environment.
196196

197197
[build-badge]: https://github.com/project-koku/koku-ui/actions/workflows/tag_release.yml/badge.svg
198-
[license-badge]: https://img.shields.io/github/license/project-koku/koku-ui.svg?longCache=true
199198
[codecov-badge]: https://codecov.io/gh/project-koku/koku-ui/graph/badge.svg?token=1hjFIy1cRe
200-
199+
[Jira]: https://issues.redhat.com/projects/COST/
201200
[koku-readme]: https://github.com/project-koku/koku#readme
201+
[koku-ui-mfe-readme]: https://github.com/project-koku/koku-ui-mfe#readme
202+
[license-badge]: https://img.shields.io/github/license/project-koku/koku-ui.svg?longCache=true
202203
[nodejs]: https://nodejs.org/en/
204+
[npm]: https://www.npmjs.com/
203205
[patch-etc-hosts]: https://github.com/RedHatInsights/insights-proxy/blob/master/scripts/patch-etc-hosts.sh
204206
[Patternfly]: https://www.patternfly.org/
205207
[release-doc]: https://github.com/project-koku/koku-ui/blob/main/RELEASE.md
206-
[npm]: https://www.npmjs.com/
207-
[Jira]: https://issues.redhat.com/projects/COST/
208+
[serving-files-locally]: https://github.com/RedHatInsights/chrome-service-backend/blob/main/docs/cloud-services-config.md#serving-files-locally

0 commit comments

Comments
 (0)