Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Portfolio Clarifications #1138

Closed
2 tasks
Tracked by #1122
edasmalchi opened this issue Jun 11, 2024 · 3 comments
Closed
2 tasks
Tracked by #1122

Docs: Portfolio Clarifications #1138

edasmalchi opened this issue Jun 11, 2024 · 3 comments
Assignees
Labels
documentation Work related to documentation. summer refactor '24

Comments

@edasmalchi
Copy link
Member

edasmalchi commented Jun 11, 2024

Reference: docs.calitp.org/data-infra/

What type of changes need to be made?
Select all that apply

  • Edits
  • Additions

Describe the changes
https://docs.calitp.org/data-infra/publishing/sections/5_notebooks_styling.html
https://docs.calitp.org/data-infra/publishing/sections/4_analytics_portfolio_site.html

Make these sections easier to follow, including without requiring reference to external links where possible. Link/integrate example notebook content in starter_kit

Some specifics:

  • Clarify that page titles come from notebook H1, not yml
  • May need to create a local index dir, if running index (also describe why/when to do this, consider tweaking script)

Files Affected:
List the files added or edited by these changes.
Ex.

  • Introduction to Analytics Tools/Notebooks

Additional context
Add any other context.
#1122

@edasmalchi
Copy link
Member Author

index command to document: #977

@amandaha8
Copy link
Contributor

amandaha8 commented Jun 19, 2024

DONE

  1. Clarify that page titles come from notebook H1, not yml
    -SB125_route_illustrations.yml
    -You might assume that page titles are from YML
    -Titles in our website come from the headers of a notebook.
    -Portfolio Script is taking something from the notebook and using it to build a table of contents.
    -H1 is the boldest header.

  2. Put deploy back to the analytics_portfolio

  3. Swap order of the pages: notebooks_styling and analytics_portfolio. Styling the notebook should come before building your YML/parameterizing/etc.

  4. May need to create a local index dir, if running index (also describe why/when to do this, consider tweaking script)
    -There’s a second command to run that will build that index page
    -PR redeploy all portfolio, except speedmaps #977 has details. (Amanda: added this to 5_analytics_portfolio_site under "Deploy your Report."

  5. Cal-ITP Analytics Portfolio: dla.yml
    Add more districts as an example to showcase how parameterization is happening

  6. Do a PR and Eric will add his stuff (Netlify key, Other Specifications, clarifying some of the markdown language).

  7. AH (new idea as of 6/25): add tips and tricks section.

  • Charts: make sure legend isn't cut off horizontally and vertically.
  • Analyze your legend.
  • View your portfolio on different screens. Things look different on a small laptop versus a large monitor.
  • Make sure all acronyms are defined.
  • Check your color palette and see if you can incorporate color blind friendly ones.
  • Check the titles of your graph.
  • Are values formatted correctly? Currencies have $ and percentages have %?
  • Any typos in your narrative?
  • As few hard coded values as possible.
  • Style your pandas dataframe
  • Can make cells of your notebook wider/narrower.
  • Are the bars of your chart arranged properly? Such as years/months are chronological (sometimes Altair sorts values differently, so January, February, March is alphabetized).

@amandaha8
Copy link
Contributor

Closed, all changes are merged into d

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Work related to documentation. summer refactor '24
Projects
Status: Done
Development

No branches or pull requests

2 participants