Skip to content

Commit 0e052a2

Browse files
committed
update readme to reflect new portfolio reality
1 parent 370f936 commit 0e052a2

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,16 @@ https://docs.calitp.org/data-infra/analytics_welcome/overview.html
1919

2020
https://docs.calitp.org/data-infra/analytics_tools/overview.html
2121

22-
## Parameterized reports
23-
24-
[The reports config file](./reports_config.yml) configures the parameterized report
25-
generation for this repo.
26-
27-
### Caveats
22+
## Publishing Reports
23+
[The sites folder](./portfolio/sites/) contains the YAML files that drive sites
24+
deployed to [https://analysis.calitp.org/](https://analysis.calitp.org/); the existing
25+
sites can be used as examples/templates for deploying additional sites. Also, the
26+
Data Services Documentation has a [specific chapter](https://docs.calitp.org/data-infra/publishing/overview.html)
27+
dedicated to various ways to publish data.
28+
29+
### Caveats (when using the portfolio site)
2830
Jupyter Book/Sphinx do not play nicely with Markdown headers written out in `display()`
2931
calls. Therefore, [portfolio.py](./portfolio.py) uses a custom Papermill
30-
engine to template Markdown cells directly.
32+
engine to template Markdown cells directly, following Python formatted-string
33+
syntax. For example, your Markdown cell could contain `# {district_name}` and
34+
it will be templated by the underlying engine.

0 commit comments

Comments
 (0)