Skip to content

Commit 078d462

Browse files
maxschulz-COLantonymilnehuong-li-nguyen
authored
[Docs] Fix permanent project links to py.cafe (#642)
Co-authored-by: Antony Milne <[email protected]> Co-authored-by: huong-li-nguyen <[email protected]>
1 parent ba8edfd commit 078d462

File tree

8 files changed

+19
-16
lines changed

8 files changed

+19
-16
lines changed
Loading

vizro-core/docs/pages/tutorials/first-dashboard.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
There is no setup needed for your first dashboard, thanks to the amazing [Py.Cafe](https://py.cafe/).
44

5-
Follow the [Edit live on Py.Cafe](https://py.cafe/stichbury/vizro-iris-analysis) link below the dashboard to see the code and experiment with it.
5+
Follow the [Edit live on Py.Cafe](https://py.cafe/vizro-official/vizro-iris-analysis-0) link and you can see the code of the below dashboard and experiment with it.
66

7-
<iframe src="https://py.cafe/stichbury/vizro-iris-analysis" width="100%" height="600px"></iframe>
7+
<iframe src="https://py.cafe/embed/vizro-official/vizro-iris-analysis-0" width="100%" height="600px"></iframe>
88

99
<!-- vale off -->
1010
## Can I break your code?
@@ -14,7 +14,7 @@ When you click the link to "Edit live on Py.Cafe" the dashboard is running insid
1414
<!-- vale off -->
1515
## How can I make my own dashboards?
1616
<!-- vale on -->
17-
You can use [Py.Cafe](https://py.cafe/) to experiment with your own Vizro dashboards by dropping code onto a new project.
17+
You can use [Py.Cafe](https://py.cafe/snippet/vizro/v1) to experiment with your own Vizro dashboards by dropping code onto a new project.
1818

1919
If you need inspiration or a starting point, we make all our examples available for you to try out on Py.Cafe. Throughout our documentation, follow the "**Run and edit this code in Py.Cafe**" link below the code snippets to open them in Py.Cafe.
2020

vizro-core/docs/pages/user-guides/assets.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ For reference, see the [Vizro CSS files](https://github.com/mckinsey/vizro/tree/
102102
Vizro().build(dashboard).run()
103103
```
104104

105-
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/stichbury/vizro-custom-header-colors">Run and edit this code in Py.Cafe</a></b>
105+
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/vizro-official/vizro-custom-header-colors-0">Run and edit this code in Py.Cafe</a></b>
106106

107107
=== "app.yaml"
108108
```yaml
@@ -164,7 +164,7 @@ Suppose you want to hide the page title on one page only. Here's how you can ach
164164
Vizro().build(dashboard).run()
165165
```
166166

167-
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/stichbury/vizro-multi-page-example">Run and edit this code in Py.Cafe</a></b>
167+
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/vizro-official/vizro-multi-page-example">Run and edit this code in Py.Cafe</a></b>
168168

169169
=== "app.yaml"
170170
```yaml
@@ -250,7 +250,7 @@ It's essential to understand the relationship between the targeted CSS class or
250250
Vizro().build(dashboard).run()
251251
```
252252
253-
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/stichbury/vizro-custom-card-styling">Run and edit this code in Py.Cafe</a></b>
253+
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/vizro-official/vizro-custom-card-styling">Run and edit this code in Py.Cafe</a></b>
254254
255255
=== "app.yaml"
256256
```yaml

vizro-core/docs/pages/user-guides/card-button.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ accessibility of your app. Providing an image ALT text is optional.
226226
Vizro().build(dashboard).run()
227227
```
228228

229-
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/app/stichbury/vizro-placing-images">Run and edit this code in Py.Cafe</a></b>
229+
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/vizro-official/vizro-placing-images">Run and edit this code in Py.Cafe</a></b>
230230

231231

232232
=== "app.yaml"
@@ -306,7 +306,7 @@ and give an attribute selector to select images with that matching URL hash.
306306
Vizro().build(dashboard).run()
307307
```
308308

309-
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/stichbury/vizro-styling-images">Run and edit this code in Py.Cafe</a></b>
309+
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/vizro-official/vizro-styling-images">Run and edit this code in Py.Cafe</a></b>
310310

311311
=== "app.yaml"
312312
```yaml
@@ -382,7 +382,7 @@ Use the following pre-defined URL hashes in your image path to apply Vizro's def
382382
Vizro().build(dashboard).run()
383383
```
384384

385-
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/stichbury/vizro-floating-images-explorer">Run and edit this code in Py.Cafe</a></b>
385+
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/vizro-official/vizro-floating-images-explorer">Run and edit this code in Py.Cafe</a></b>
386386

387387
=== "app.yaml"
388388
```yaml

vizro-core/docs/pages/user-guides/custom-components.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ As mentioned above, custom components can trigger action. To enable the custom c
472472

473473
Vizro().build(dashboard).run()
474474
```
475-
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/stichbury/vizro-custom-carousel-component">Run and edit this code in Py.Cafe</a></b>
475+
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/vizro-official/vizro-custom-carousel-component">Run and edit this code in Py.Cafe</a></b>
476476
=== "yaml"
477477
```yaml
478478
# Custom components are currently only possible via python configuration

vizro-core/docs/pages/user-guides/custom-figures.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ number of cards displayed dynamically adjusts based on a `vm.Parameter`.
245245
The parameter targets the `n_rows` argument of the `multiple_cards` function, determining the number of rows
246246
taken from the data.
247247

248-
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/stichbury/vizro-dynamic-cards">Run and edit this code in Py.Cafe</a></b>
248+
<img src=https://py.cafe/logo.png alt="py.cafe logo" width="30"><b><a target="_blank" href="https://py.cafe/vizro-official/vizro-dynamic-cards">Run and edit this code in Py.Cafe</a></b>
249249

250250
=== "styling.css"
251251
```css

vizro-core/docs/pages/user-guides/run.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,16 @@ This guide shows you how to launch your dashboard in different ways. By default,
44

55
## Py.Cafe
66

7-
You can launch your dashboard and edit the code live on [Py.Cafe](https://py.cafe/).
7+
The easiest way to launch your dashboard is to edit the code live on [Py.Cafe](https://py.cafe/).
88

9-
For this basic example, follow the [Edit live on Py.Cafe](https://py.cafe/stichbury/vizro-iris-analysis) link below the dashboard to experiment with the code.
9+
Most of our examples have a link below the code, [Run and edit this code in Py.Cafe](https://py.cafe/vizro-official/vizro-iris-analysis-0), which you can follow to experiment with the code. This will lead you to an editor such as the one below, which displays the dashboard and the code side by side.
1010

11-
<iframe src="https://py.cafe/stichbury/vizro-iris-viz" width="100%" height="600px"></iframe>
11+
<figure markdown="span">
12+
![Py.Cafe editor](../../assets/user_guides/run/pycafe_editor.png)
13+
<figcaption>Enter your dashboard code on the left, and see the results immediately reflected in the app on the right.</figcaption>
14+
</figure>
1215

13-
You can use [Py.Cafe](https://py.cafe/) to experiment with your own Vizro dashboards by dropping code into a new project.
16+
You can use [Py.Cafe](https://py.cafe/snippet/vizro/v1) snippet mode to experiment with your own Vizro dashboards by dropping code into a new project.
1417

1518

1619
## Default built-in Flask development server

vizro-core/mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ markdown_extensions:
109109
kwds:
110110
type: vizro
111111
requirements: |
112-
vizro
112+
vizro==0.1.20
113113
ruff==0.6.1 # mock
114114
- pymdownx.tabbed:
115115
alternate_style: true

0 commit comments

Comments
 (0)