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

Remove pudl@catalyst.coop from docs #2670

Merged
merged 2 commits into from
Jun 28, 2023
Merged

Conversation

bendnorman
Copy link
Member

@bendnorman bendnorman commented Jun 15, 2023

PR Overview

#2665 removed references to pudl@catalyst.coop from datasette. This PR removes pudl@catalyst.coop from a couple of other public-facing pages to discourage folks from emailing pudl@catalyst.coop and instead asking questions on GitHub discussions.

Places pudl@catalyst.coop was not removed:

  1. pyproject.toml and src/pudl/__init__.py: I think PyPi gets the email contact information from at least one of these files.
  2. CODE_OF_CONDUCT.md: If folks need to report inappropriate behavior it should not be public!
  3. src/pudl/metadata/constants.py, src/pudl/metadata/sources.py: I think the zenodo archives pull contact information from these files.

PR Checklist

  • Merge the most recent version of the branch you are merging into (probably dev).
  • All CI checks are passing. Run tests locally to debug failures
  • Make sure you've included good docstrings.
  • For major data coverage & analysis changes, run data validation tests
  • Include unit tests for new functions and classes.
  • Defensive data quality/sanity checks in analyses & data processing functions.
  • Update the release notes and reference reference the PR and related issues.
  • Do your own explanatory review of the PR to help the reviewer understand what's going on and identify issues preemptively.

@bendnorman bendnorman marked this pull request as draft June 15, 2023 00:08
@codecov
Copy link

codecov bot commented Jun 15, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (5b3b6fd) 87.1% compared to head (f67751a) 87.1%.

Additional details and impacted files
@@          Coverage Diff          @@
##             dev   #2670   +/-   ##
=====================================
  Coverage   87.1%   87.1%           
=====================================
  Files         86      86           
  Lines      10021   10021           
=====================================
  Hits        8736    8736           
  Misses      1285    1285           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@e-belfer e-belfer left a comment

Choose a reason for hiding this comment

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

These changes look good to me. Makes sense to leave the email in in the other places.

@bendnorman bendnorman requested a review from aesharpe June 26, 2023 17:21
@bendnorman bendnorman marked this pull request as ready for review June 26, 2023 17:21
Copy link
Member

@aesharpe aesharpe left a comment

Choose a reason for hiding this comment

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

I ran the docs build and found a mention of pudl@catalyst.coop that wasn't mentioned in the comments:

The Data Access page still references pudl.catalyst.coop:

if you have suggestions or questions please open a GitHub issue or email us at pudl@catalyst.coop.

Comment on lines -253 to +255
* For private communication about the project or to hire us to provide customized data
* To hire us to provide customized data
extraction and analysis, you can email the maintainers:
`pudl@catalyst.coop <mailto:pudl@catalyst.coop>`__
`hello@catalyst.coop <mailto:hello@catalyst.coop>`__
Copy link
Member

Choose a reason for hiding this comment

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

The "Contact Us" section on the docs index page says something similar but uses the pudl@catalyst.coop email:

For private communication about the project or to hire us to provide customized data extraction and analysis, you can email the maintainers: pudl@catalyst.coop

We should pick either hello@catalyst or pudl@catalyst and keep it the same for both.

@bendnorman
Copy link
Member Author

Hey @aesharpe! I rebuilt the docs locally and viewed the docs built by the RTD CI, and I couldn't find the errors you mentioned. Sometimes I need to force reload the docs built by the RTD CI to see the new changes.

@aesharpe
Copy link
Member

Hey @aesharpe! I rebuilt the docs locally and viewed the docs built by the RTD CI, and I couldn't find the errors you mentioned. Sometimes I need to force reload the docs built by the RTD CI to see the new changes.

Hmmm I wonder if I ran the docs build on the wrong branch or something. It also looks fine to me. In which case, smash merge!

@bendnorman bendnorman merged commit 1d22efd into dev Jun 28, 2023
10 checks passed
@bendnorman bendnorman deleted the remove-pudl-email-in-docs branch June 28, 2023 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants