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

[teraslice-chart] Fix docs and index.yaml issue with teraslice-chart #3920

Open
sotojn opened this issue Jan 25, 2025 · 1 comment
Open

[teraslice-chart] Fix docs and index.yaml issue with teraslice-chart #3920

sotojn opened this issue Jan 25, 2025 · 1 comment
Assignees

Comments

@sotojn
Copy link
Contributor

sotojn commented Jan 25, 2025

We recently added a pipeline that publishes the teraslice helm chart and create some docs located here.

There are several missed issues having to do with the new docs and some cleanup that still needs to be done in some areas.

  • Add an icon to the https://terascope.github.io/teraslice/charts/ docs
  • Fix the url at the bottom that leads to the oci url which is invalid in browsers
  • Delete the teraslice entry in the index.yaml.
    • We would need to do this in its own PR because workflows won't trigger if this file is merged to master.
  • Add the KindConfig.yaml copy and paste to the docs
  • Add a link in the top level docs to helm chart docs
  • Create a better "Quick Start" guide that has creative examples on how teraslice can be used
    • Perhaps bundling a side cart container with the chart that can generate data and create jobs on startup. Also autoload necessary assets
@sotojn sotojn self-assigned this Jan 25, 2025
@sotojn sotojn changed the title [teraslice-chart] Fix doc and index.yaml issue with teraslice-chart [teraslice-chart] Fix docd and index.yaml issue with teraslice-chart Jan 27, 2025
@sotojn sotojn changed the title [teraslice-chart] Fix docd and index.yaml issue with teraslice-chart [teraslice-chart] Fix docs and index.yaml issue with teraslice-chart Jan 27, 2025
@godber
Copy link
Member

godber commented Jan 28, 2025

Here's where AWS lists the public datasets: https://registry.opendata.aws/

Searching it for something with csv in the description shows us the old reliable NOAA datasets:

https://registry.opendata.aws/noaa-ghcn/

Check some stuff out:

# list the files
aws s3 ls --human-readable --no-sign-request s3://noaa-ghcn-pds/csv/by_year/
...
2025-01-28 05:47:54    1.2 GiB 2024.csv
2025-01-28 05:46:23   66.4 MiB 2025.csv

# copy this years file locally
aws s3 cp --no-sign-request s3://noaa-ghcn-pds/csv/by_year/2024.csv .
download: s3://noaa-ghcn-pds/csv/by_year/2024.csv to ./2024.csv

# whats in the file
tail 2024.csv
ASN00019061,20241231,PRCP,0,,,a,
ASN00019062,20241231,TMAX,344,,,a,
ASN00019062,20241231,TMIN,142,,,a,
ASN00019062,20241231,PRCP,0,,,a,
ASN00019115,20241231,PRCP,0,,,a,
ASN00019116,20241231,PRCP,0,,,a,
ASN00020020,20241231,PRCP,0,,,a,
ASN00020028,20241231,TMAX,362,,,a,
ASN00020028,20241231,TMIN,156,,,a,
ASN00020028,20241231,PRCP,0,,,a,

Oh yeah, this data sucks, it needs to be pivoted.

busma13 pushed a commit that referenced this issue Jan 31, 2025
This PR makes the following changes:

- Removes an invalid entry `teraslice` in the index.yaml
- This is because we use the chart name `teraslice-chart` instead and
the extra entry in the repo is broken and unnecessary

 Ref to issue #3920
busma13 pushed a commit that referenced this issue Jan 31, 2025
This PR makes the following changes:

- Adds an icon to the teraslice chart web docs page
- Adds chart link in the navigation bar of the teraslice web docs
- Miscellaneous link fixes on the chart web docs
- Add kindConfig copy paste to the helm chart docs.
- Add config docs to the helm chart 

Ref to issue #3920
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants