You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-22
Original file line number
Diff line number
Diff line change
@@ -63,28 +63,8 @@ with underscores.
63
63
* For examples, refer to [sample.yml](https://github.com/aochen-jli/visualizations/blob/main/examples/visualizations/config/sample.yml) or
64
64
the config files [here](https://github.com/vbrunsch/rankings/tree/main/visualizations/config)
65
65
* The file extension must be .yml, not .yaml
66
-
4. Copy the example [values.yaml](https://github.com/aochen-jli/visualizations/blob/main/examples/visualizations/values.yaml) into your visualizations folder and configure it
67
-
1. Add your configured regions to the `regions` section. The `path` value is required and should equal the
68
-
`{region}` value referenced in the above sections. If you wish to integrate your visualizations with the
69
-
[landing page](https://github.com/aochen-jli/visualizations-landing), you need to add the `name`
70
-
and optional `fake` value, as shown below. The `name` value allows you to set the exact display name for
71
-
your region and the `fake` value is used to indicate that a region does **not** have a visualization:
72
-
```yaml
73
-
regions:
74
-
- name: Sample
75
-
path: sample
76
-
- name: Subsample
77
-
path: sample/subsample
78
-
- name: Region That Is Just For Display
79
-
path: sample/subsample/just_for_display
80
-
fake: true
81
-
```
82
-
2. Add the domains that the visualizations will be served/embedded on to the `allowedOrigins` section:
83
-
```yaml
84
-
allowedOrigins:
85
-
- localhost
86
-
- example.com
87
-
```
66
+
4. Copy the example [values.yaml](https://github.com/aochen-jli/visualizations/blob/main/examples/visualizations/values.yaml) into
67
+
your visualizations folder and configure it according to the documentation.
88
68
5. If you do not have a build and deployment pipeline configured for your repository, you can create
89
69
one [here](https://github.com/aochen-jli/visualizations-cicd/tree/main/pipelines) and submit a pull
0 commit comments