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

Edit and Update: Enhancements to Cal-ITP Data Services Documentation #1277

Open
11 of 19 tasks
shweta487 opened this issue Nov 4, 2024 · 7 comments
Open
11 of 19 tasks
Assignees
Labels
documentation Work related to documentation.

Comments

@shweta487
Copy link
Contributor

shweta487 commented Nov 4, 2024

Introduction
This issue focuses on updating the Cal-ITP Data Services documentation as part of a broader initiative to enhance the analyst curriculum.

Files Affected:
Cal-ITP Data Services Documentation

The following specific tasks will be addressed:

Remove outdated components

Update Urls

Update Contents

Additional Resources

Update Exercise related content and chronology

  • Update existing code examples with relevant modifications and context.
  • Revise the chronology of exercises to better align with new content and learning objectives.
@shweta487 shweta487 added the documentation Work related to documentation. label Nov 4, 2024
@amandaha8
Copy link
Contributor

For this page, there's a part that says "Still need access to a tool on this page? Ask in the #services-team channel in the Cal-ITP Slack." I don't think that channel exists anymore so maybe this should be replaced?

@amandaha8
Copy link
Contributor

I feel like we can erase everything after the Communication Channels on this How We Work page but I think you already did this!

@amandaha8
Copy link
Contributor

For helpful links you can erase

@amandaha8
Copy link
Contributor

amandaha8 commented Nov 7, 2024

You mentioned talking about when turning a notebook into a PDF and it's addressed here.

  • The only edit you have to make is to delete this text: There are assignments that require you to rerun the same notebook for different values and save each of these new notebooks in PDF format. This essentially combines parameterization principles using papermill with the weasyprint steps above. You can reference the code that was used to generate the CSIS scorecards here. This script iterates over this notebook to produce 50+ PDF files for each of the nominated projects..
  • Then paste in this text: There are assignments that require you to rerun the same notebook for different values and save each of these new notebooks in PDF format. This essentially combines parameterization principles using papermill with the weasyprint steps above. You can reference the code that was used to generate the CSIS scorecards here. This script iterates over this notebook to produce PDF files for each of the nominated projects found here.

@amandaha8
Copy link
Contributor

Do you know what you are supposed to write for the GCS public bucket? I am not really familiar with this, never used this public bucket before. Maybe Eric or Tiffany can work on this page?

@KatrinaMKaiser
Copy link
Member

For this page, there's a part that says "Still need access to a tool on this page? Ask in the #services-team channel in the Cal-ITP Slack." I don't think that channel exists anymore so maybe this should be replaced?

fyi services-team still exists! It's in External Connections.

@amandaha8
Copy link
Contributor

There is a broken link on this page. I highlighted the sentence in bold.

Our team often uses Google Cloud Storage (GCS) for object storage. If you haven’t set up your Google authentication, go here for the instructions. For a walkthrough on how to use GCS buckets, go here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Work related to documentation.
Projects
None yet
Development

No branches or pull requests

3 participants