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

Add a web docs page explaining the API changes and how to update. #144

Merged
merged 4 commits into from
Jun 27, 2024

Conversation

jatkinson1000
Copy link
Member

This PR adds a web docs page explaining the API changes and how to update following the breaking changes of #136 and #143

This can then be sent to known users to help them update.

@jatkinson1000 jatkinson1000 added the documentation Improvements or additions to documentation label Jun 26, 2024
@jatkinson1000 jatkinson1000 self-assigned this Jun 26, 2024
@dorchard
Copy link
Member

Alongside this perhaps we should bump the package number here:

set(PACKAGE_VERSION 0.1)

And perhaps a change to switch to semantic versioning?

@jatkinson1000
Copy link
Member Author

We could, but I am not sure it carries much meaning since we haven't updated it so far...
My plans were to make a JOSS release v1.0.0 and then be more rigorous from that point.

Copy link
Member

@TomMelt TomMelt left a comment

Choose a reason for hiding this comment

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

@jatkinson1000 this is amazing. Thanks for doing this. It's really clear what the changes are and how to upgrade to the new API. Super 🚀

@jatkinson1000
Copy link
Member Author

Thanks @TomMelt I will wait for Joe to have a final look over #143 and then merge this after that goes in.

I'm collating a list of users to email so please add any users you are aware of that I need to email here @dorchard @jwallwork23:

  • Laura Mansfield and Stanford
  • Will Chapman and NCAR
  • H. Heuer and ICON
  • vbalmer
  • WaveWatch 3

Copy link
Contributor

@jwallwork23 jwallwork23 left a comment

Choose a reason for hiding this comment

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

Very clear, nice! One optional minor comment.

pages/updates.md Outdated Show resolved Hide resolved
@jatkinson1000
Copy link
Member Author

Minor Aesthetic changes to the webpage and added a note to the README to highlight until v1.0.0.
Issue #146 opened to remind us to revert these changes after a suitable period.

@jatkinson1000 jatkinson1000 merged commit 4d83a1a into main Jun 27, 2024
5 checks passed
@jatkinson1000 jatkinson1000 deleted the changelog branch June 27, 2024 11:38
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
None yet
Development

Successfully merging this pull request may close these issues.

4 participants