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

Update the docs for V2 Changes #220

Merged
merged 8 commits into from
May 15, 2024
Merged

Update the docs for V2 Changes #220

merged 8 commits into from
May 15, 2024

Conversation

@alexander0042
Copy link
Collaborator

Great, just pushed another set of additions to the V2.0 docs branch, which should round out all those updates.

One thing I was thinking about was what sort of stuff should go in the HA docs that isn't already included? I added some stuff on alerts, but are there more FAQ's that should be added? Or something more fundamental?

@cloneofghosts
Copy link
Collaborator Author

cloneofghosts commented May 7, 2024

Was looking through the changes and I don't see anything specific in the HA docs about the alerts sensor. Maybe I missed it but it looks like it's not there? For the HA docs I'd include a link to the data points section in the API documentation. I would document any specific HA things in there that don't apply to the regular API. Be it as FAQs or just regular documentation.

The only other changes needed are the recent updates section on the homepage and the OpenAPI specification as it looks like they were missed.

For the roadmap should RRFS and 3DRTMA be added to the sources list? They're not available yet but should hopefully be released this year. Both will cover all of North America and have a subhourly version.

docs/API.md Outdated Show resolved Hide resolved
docs/DataSources.md Outdated Show resolved Hide resolved
@cloneofghosts
Copy link
Collaborator Author

Also as per this comment maybe you should clarify where the storm distance is measured from?

Copy link
Collaborator Author

@cloneofghosts cloneofghosts left a comment

Choose a reason for hiding this comment

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

Just had another look through the data sources document and just wanted to confirm where the data is coming from. Thought that the comment would just show the line I added the comment to. If you click view reviewed changes it will show the comment better.

For the data sources section maybe it would be a good idea to add the data pipeline table and update it for NBM> Should also add the note about HRRR/NBM last update times being off when compared to the sub-hourly HRRR.

docs/DataSources.md Outdated Show resolved Hide resolved
docs/DataSources.md Outdated Show resolved Hide resolved
docs/DataSources.md Outdated Show resolved Hide resolved
docs/DataSources.md Outdated Show resolved Hide resolved
docs/DataSources.md Outdated Show resolved Hide resolved
docs/DataSources.md Outdated Show resolved Hide resolved
docs/DataSources.md Outdated Show resolved Hide resolved
docs/DataSources.md Outdated Show resolved Hide resolved
docs/DataSources.md Outdated Show resolved Hide resolved
docs/DataSources.md Outdated Show resolved Hide resolved
@alexander0042
Copy link
Collaborator

Incredible notes, these are great! I'll go through them and double check each one.

Also, note for myself- smoke is ins kg/m3 (the model default), but ug/m3 makes way more sense. Need the docs to report ug/m3 and multiply the response by 10^9

@cloneofghosts
Copy link
Collaborator Author

cloneofghosts commented May 7, 2024

I fixed the missed spelling change and I updated a few items in the table that I'm sure of but you should double check and make sure.

EDIT: Oh and 2.0.5 will also need to be added to the changelog whenever it gets launched.

@alexander0042
Copy link
Collaborator

Like I said earlier, amazing edits!!! I went through and put them all in, as well as updating the data pipeline page with the new times. I'm going to supersede that page with the details on the new V2 processing flow, but since that's just for general interest I want to get this out first.

Also added some more details on the storm distance, and updated the changelog/ roadmap.

Also really good comment on the OpenAPI specs. Apiable really likes having those, and it's good practice, so I'll add those in before we push this.

@cloneofghosts
Copy link
Collaborator Author

cloneofghosts commented May 8, 2024

Just took a look through and everything looks good. I think this is everything left before we can merge this in

@cloneofghosts
Copy link
Collaborator Author

@alexander0042 I've updated the OpenAPI spec if you want to double check and make sure everything is good there. I also added in the new sensors into the HA docs page. Is there anything from my last comment that you want to add or is it good to merge?

@cloneofghosts cloneofghosts marked this pull request as ready for review May 10, 2024 17:14
@cloneofghosts
Copy link
Collaborator Author

I added the new sensors which I added yesterday and the template from the templating issue in HA. @alexander0042 I think things are good now if you could review so we can get this merged in.

@cloneofghosts cloneofghosts added the documentation Improvements or additions to documentation label May 14, 2024
@alexander0042 alexander0042 merged commit e026f2f into main May 15, 2024
@alexander0042
Copy link
Collaborator

Ok, with that fire out I finally had a chance to review this! Read through it all and it's looking good, so I'm going to push to main and see how everything formats

Copy link
Collaborator

@alexander0042 alexander0042 left a comment

Choose a reason for hiding this comment

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

Great edits, looks good to me!

@cloneofghosts
Copy link
Collaborator Author

Was just about to go and fix the changelog version but you beat me to it and added 2.0.6 and 2.0.7. The OpenAPI spec will need to have the versions changed but that's pretty minor.

@cloneofghosts cloneofghosts deleted the Docs2.0 branch May 15, 2024 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
2 participants