Skip to content

Commit 042d770

Browse files
committed
Update documentation for home page integration
1 parent 4db5d9e commit 042d770

File tree

3 files changed

+14
-28
lines changed

3 files changed

+14
-28
lines changed

README.md

+2-22
Original file line numberDiff line numberDiff line change
@@ -63,28 +63,8 @@ with underscores.
6363
* For examples, refer to [sample.yml](https://github.com/aochen-jli/visualizations/blob/main/examples/visualizations/config/sample.yml) or
6464
the config files [here](https://github.com/vbrunsch/rankings/tree/main/visualizations/config)
6565
* 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.
8868
5. If you do not have a build and deployment pipeline configured for your repository, you can create
8969
one [here](https://github.com/aochen-jli/visualizations-cicd/tree/main/pipelines) and submit a pull
9070
request. Or, you can ask Jason to create one.

examples/visualizations/values.yaml

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# This is the list of regions that will be deployed. The 'name' value should be the full name of the region,
2-
# capitalized, with spaces and all. The 'path' value should correspond directly to the name
3-
# of the visualization configuration YAML files.
1+
# This is the list of regions that will be deployed. The 'path' value is required and should correspond directly to
2+
# the name of the visualization configuration YAML files. If you wish to integrate your visualizations with the
3+
# home page, you need to add the 'name' and 'fake' values (default: false), as shown below. The 'name' value
4+
# allows you to set the exact display name for your region and the 'fake' value must be used to indicate when
5+
# a region does not have a visualization. This may occur, for example, if you have visualizations for some cities
6+
# and you represent them as subregions of a state, but you do not have a visualization for that state.
47
regions:
58
- name: Sample
69
path: sample

helm/chart/values.yaml

+6-3
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,12 @@ affinity: {}
5454
# repositoryPath: https://raw.githubusercontent.com/vbrunsch/rankings/main/visualizations
5555
repositoryPath:
5656

57-
# This is the list of regions that will be deployed. The 'name' value should be the full name of the region,
58-
# capitalized, with spaces and all. The 'path' value should correspond directly to the name
59-
# of the visualization configuration YAML files.
57+
# This is the list of regions that will be deployed. The 'path' value is required and should correspond directly to
58+
# the name of the visualization configuration YAML files. If you wish to integrate your visualizations with the
59+
# home page, you need to add the 'name' and 'fake' values (default: false), as shown below. The 'name' value
60+
# allows you to set the exact display name for your region and the 'fake' value must be used to indicate when
61+
# a region does not have a visualization. This may occur, for example, if you have visualizations for some cities
62+
# and you represent them as subregions of a state, but you do not have a visualization for that state.
6063
# Example:
6164
# regions:
6265
# - name: Germany

0 commit comments

Comments
 (0)