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 - Replacing Slack References #3772

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion docs/analytics_new_analysts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Tutorials for New Python Users

This section is geared towards data analysts who are new to Python. The following tutorials highlight the most relevant Python skills used at Cal ITP. Use them to guide you through completing [practice exercises #1-9](https://github.com/cal-itp/data-analyses/tree/main/starter_kit).
This section is geared towards data analysts who are new to Python. The following tutorials highlight the most relevant Python skills used at Cal ITP. Use them to guide you through completing [the exercises in our `starter_kit` repo.](https://github.com/cal-itp/starter_kit).

## Content

Expand Down
8 changes: 2 additions & 6 deletions docs/analytics_onboarding/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,11 @@
- See below for list of our collaboration and analysis tools.
- As part of your onboarding, privileges have already been created for you to access the resources below.

**Non-Analyst Team Members**

- Any of the tools below are available to you as well!

**If you still need help with access**, use the information at the bottom of this page to [**get help**](get-help).
:::
**Collaboration Tools:**

- [ ] [**Slack**](https://cal-itp.slack.com) | ([Docs](slack-intro))
- [ ] Microsoft Teams
- [ ] [**Analytics Repo**](https://github.com/cal-itp/data-analyses) | ([Docs](analytics-repo))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll spend more time with this code Monday but it looks like the links to other docs pages are broken - that's causing the build to error: /home/runner/work/data-infra/data-infra/docs/analytics_onboarding/overview.md:17: WARNING: 'myst' cross-reference target not found: 'analytics-repo' [myst.xref_missing]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Katrina, I'm having trouble figuring out what is wrong.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what is looks like when I'm looking at main, but the Docs links are internal references that are supposed to link to other pages inside of the same subfolder that the page itself is located in. Right now those pages don't exist or are in some other folder?
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that being said, idk why this doesn't present a problem with the link behavior on the actual published docs page

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KatrinaMKaiser It built! I changed the link. I don't know how this never presented a problem, a page for analytics-repo never existed in the first place.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you confirm that the other Docs links on that page work and go to the correct pages?

- [ ] [**Analyst Project Board**](https://github.com/cal-itp/data-analyses/projects/1)
- [ ] [**Google Cloud Storage**](https://console.cloud.google.com/storage/browser/calitp-analytics-data) | ([Docs](storing-new-data))
Expand All @@ -33,7 +29,7 @@
**Python Libraries:**

- [ ] [**calitp-data-analysis**](https://github.com/cal-itp/data-infra/tree/main/packages/calitp-data-analysis/calitp_data_analysis) - Cal-ITP's internal Python library for analysis | ([Docs](calitp-data-analysis))
- [ ] [**siuba**](https://siuba.org/) - Recommended data analysis library | ([Docs](siuba))
- [ ] [**siuba**](https://siuba.org/) - Data analysis library we use to query data from the warehouse| ([Docs](siuba))
- [ ] [**shared_utils**](https://github.com/cal-itp/data-analyses/tree/main/_shared_utils) - A shared utilities library for the analytics team | ([Docs](shared-utils))

**Caltrans Employee Resources:**
Expand Down
2 changes: 1 addition & 1 deletion docs/analytics_tools/jupyterhub.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This avoids the need to set up a local environment, provides dedicated storage,

JupyterHub currently lives at [notebooks.calitp.org](https://notebooks.calitp.org/).

Note: you will need to have been added to the Cal-ITP organization on GitHub to obtain access. If you have yet to be added to the organization and need to be, ask in the `#services-team` channel in Slack.
**Note**: you need be added to the Cal-ITP organization on GitHub to use JupyterHub. Tag Evan Siroky on the `Data Analysis` channel on Teams to ask for access.

(default-user-vs-power-user)=

Expand Down
3 changes: 1 addition & 2 deletions docs/analytics_tools/tools_quick_links.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
| Tool | Purpose |
| -------------------------------------------------------------------------------------------------- | --------------------------------------- |
| [**Analytics Repo**](https://github.com/cal-itp/data-analyses) | Analytics team code repository. |
| [**Analytics Project Board**](https://github.com/cal-itp/data-analyses/projects/1) | Analytics team list of active issues. |
| [**notebooks.calitp.org**](https://notebooks.calitp.org/) | JupyterHub cloud-based notebooks |
| [**dashboards.calitp.org**](https://dashboards.calitp.org/) | Metabase dashboards & Business Insights |
| [**dbt-docs.calitp.org**](https://dbt-docs.calitp.org/) | DBT warehouse documentation |
Expand All @@ -18,5 +17,5 @@
 

```{admonition} Still need access to a tool on this page?
Ask in the `#services-team` channel in the Cal-ITP Slack.
Ask in the `Data Analysis` channel on Teams.
```
33 changes: 23 additions & 10 deletions docs/analytics_welcome/how_we_work.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,39 @@ The section below outlines our team's primary meetings and their purposes, as we

**New analysts**, look out for these meetings to be added to your calendar.

| Name | Cadence | Description |
| ------------------------ | -------------------- | ---------------------------------------------------------------------------- |
| **Technical Onboarding** | Week 1 <br/> 40 Mins | To ensure access to tools and go over best practices. |
| **Analyst Team Meeting** | Thurs <br/> 45 Mins | Branch meeting to share your screen and discuss what you've been working on. |
| Name | Cadence | Description |
| ----------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| **Technical Onboarding** | Week 1 <br/> 40 Mins | To ensure access to tools and go over best practices. |
| **Analyst Data Roundtable Meeting** | Thursday, Weekly <br/> 50 Mins | Branch meeting to share your screen and discuss what you've been working on. |
| **Analyst Administrative Meeting** | Wednesday, Bi-Weekly <br/> 25 Mins | Branch meeting for administrative updates every other Wednesday. |
| **Team Social Meeting (Optional)** | Wednesday, Bi-Weekly <br/> 60 Mins | Due to the geographic spread of our branch, every other Wednesday we get together for an optional hour of chatting. |

(slack-intro)=

## Communication Channels
## Teams Communication Channels

When communicating with Caltrans coworkers, we use Teams. The message retention policy for Teams is not permanent. [Open up a GitHub Issue](https://github.com/cal-itp/data-analyses/issues) with the appropriate template for any posts you make on the **Data Analysis** and **Data Office Hours** channels that are worth keeping for posterity's sake and/or are lengthy and complex in nature.

| Channel | Purpose | Description |
| ---------------------- | ---------- | -------------------------------------------------------------------------- |
| #**General** | Discussion | For all employees in Caltrans Division of Data and Digital Services (DDS). |
| #**Data Analysis** | Discussion | For sharing and collaborating on data analyses. |
| #**Data Office Hours** | Discussion | A place to bring questions, issues, and observations for team discussion. |
| #**Data Science** | Discussion | For all employees in DDS's Data Science Branch. |

## Slack Communication Channels

When working with contractors, we use Slack.

| Channel | Purpose | Description |
| ------------------------ | ---------- | ------------------------------------------------------------------------------------------- |
| #**ct-bdat-internal** | Discussion | For Caltrans Division of Data and Digital Services employees. |
| #**data-analysis** | Discussion | For sharing and collaborating on Cal-ITP data analyses. |
| #**data-office-hours** | Discussion | A place to bring questions, issues, and observations for team discussion. |
| #**data-warehouse-devs** | Discussion | For people building dbt models - focused on data warehouse performance considerations, etc. |

(analytics-repo)=
| (analytics-repo)= | | |

### GitHub Analytics Repo

The `data-analyses` repo is our main data analysis repository, for sharing quick reports and works in progress. Get set up on GitHub and clone the data-analyses repository [using this link](saving-code-jupyter).

For collaborative short-term tasks, create a new folder and work off a separate branch.

For large and long-term projects, create a whole new repo.
4 changes: 4 additions & 0 deletions docs/analytics_welcome/what_is_calitp.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ A selection of resources taken from the above document providing background on t
- [Market Sounding](https://dot.ca.gov/-/media/dot-media/cal-itp/documents/final-cal-itp-market-sounding-market-response-summary-103119b-a11y.pdf): This 2019 market sounding laid the foundation for our current priorities. It was followed up with a business case analysis of the project in a [Feasibility Study](https://dot.ca.gov/-/media/dot-media/cal-itp/documents/calitp-feasibility-study-042420-a11y.pdf).
- This [project framework orientation deck](https://docs.google.com/presentation/d/1zsEp2KoKyPlE34AJyqBPeSdv_ySYd6n-zcmrkdTftgo/edit) highlights some of the history of Cal-ITP, how it came to be, and the problems it is trying to solve.
- [The 2022 roadmap deck](https://docs.google.com/presentation/d/11DgqhoEqDUFJLTo71OkyWVtpih9-HzUF33DPT6M59N4/edit?usp=sharing) presents our 2022 milestones, projects, and collaboration teams “looking forward” for the year.

## How Cal-ITP relates to DDS

- Copy here.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were we waiting on something from @edasmalchi here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KatrinaMKaiser Yes! I had forgotten to remind Eric.

6 changes: 3 additions & 3 deletions docs/publishing/sections/5_analytics_portfolio_site.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Now that your notebook(s) are portfolio-ready, it's time to publish your work to

## Netlify Setup

Netlify is the platform turns our Jupyter Notebooks uploaded to GitHub into a full website.
Netlify is the platform turns our Jupyter Notebooks uploaded to GitHub into a webpage.

To setup your netlify key:
**To setup your netlify key:**

- Ask in Slack/Teams for a Netlify key if you don't have one yet.
- Ask on the Teams `Data Analysis` channel for a Netlify key if you don't have one yet.
- If you already have your Netlify key set up, find it by typing `cat ~/.bash_profile` into the root of your repo.
- Install netlify: `npm install -g netlify-cli`
- Navigate to your main directory
Expand Down
Loading