Skip to content
This repository was archived by the owner on Jul 19, 2023. It is now read-only.

Commit 877b118

Browse files
authored
Add links to frontend README (#762)
* Add links to frontend README Signed-off-by: hi-rustin <rustin.liu@gmail.com> * Fix link format Signed-off-by: hi-rustin <rustin.liu@gmail.com> * Make sure you have the backend running Signed-off-by: hi-rustin <rustin.liu@gmail.com> --------- Signed-off-by: hi-rustin <rustin.liu@gmail.com>
1 parent faf62ed commit 877b118

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

public/README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,33 @@
11
# Frontend
22

33
## tl;dr
4-
```
4+
5+
```bash
56
yarn install
7+
# Make sure you have the backend running.
68
yarn dev
79
```
810

911
## Overrides
10-
This repository currently uses `grafana/pyroscope` components, which then are overridden as necessary,
11-
using typescript's alias and webpack alias configuration. See `tsconfig.json` and `webpack.common.js`
12+
13+
This repository currently uses [grafana/pyroscope] components, which then are overridden as necessary,
14+
using typescript's alias and webpack alias configuration. See [tsconfig.json] and [webpack.common.js]
1215
for more info.
1316

17+
[tsconfig.json]: ../tsconfig.json
18+
[webpack.common.js]: ../scripts/webpack/webpack.common.js
1419

1520
### Guidelines for imports
1621

1722
It may be confusing to see different imports, so let's go over the most common examples:
1823

19-
`@webapp` -> Refers to `pyroscope-oss`, aka `grafana/pyroscope` repo.
20-
`@pyroscope/webapp` -> Refers to `pyroscope-oss`, aka `grafana/pyroscope` repo.
24+
`@webapp` -> Refers to `pyroscope-oss`, aka [grafana/pyroscope] repo.
25+
`@pyroscope/webapp` -> Refers to `pyroscope-oss`, aka [grafana/pyroscope] repo.
2126
`@phlare` -> Refers to code in this repository. Note that this is needed since other
2227
downstream repositories may use this repository, and they also may want to override specific files.
2328

24-
In the future, once both `grafana/pyroscope` and `grafana/phlare` are merged, there will
25-
be no need for `@webapp` and similar to happen, since there will be no `grafana/pyroscope` repo anymore.
29+
In the future, once both [grafana/pyroscope] and [grafana/phlare] are merged, there will
30+
be no need for `@webapp` and similar to happen, since there will be no [grafana/phlare] repo anymore.
31+
32+
[grafana/pyroscope]: https://github.com/grafana/pyroscope
33+
[grafana/phlare]: https://github.com/grafana/phlare

0 commit comments

Comments
 (0)