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 plugin quickstart docs page #446

Merged
merged 38 commits into from
Sep 21, 2023
Merged

add plugin quickstart docs page #446

merged 38 commits into from
Sep 21, 2023

Conversation

savente93
Copy link
Contributor

@savente93 savente93 commented Jul 17, 2023

Issue addressed

Fixes #375

Explanation

This PR should be reviewed together with https://github.com/savente93/hydromt-plugin-template. Currently the docs are still lacking a bit, but a good start has been made.

Checklist

  • Updated tests or added new tests
  • Branch is up to date with main
  • Tests & pre-commit hooks pass
  • Updated documentation if needed
  • Updated changelog.rst if needed

Additional Notes (optional)

Add any additional notes or information that may be helpful.

@savente93 savente93 marked this pull request as ready for review July 21, 2023 13:31
@savente93
Copy link
Contributor Author

Fixes #464

@savente93 savente93 linked an issue Jul 31, 2023 that may be closed by this pull request
1 task
@hboisgon
Copy link
Contributor

hboisgon commented Sep 1, 2023

Thanks for giving this a good start @savente93 ! I now wrote what I hope should be quite a complete guide on how to develop a plugin. It does quote some parts of the dev guide but I thought nice for users to have everything (with links!) in one place.

We discussed that there is not enough figures in our docs so I added 2 of them. If they are not nice or clear we can remove or adapt. The powerpoint version is in our sharepoint.

Maybe @DirkEilander you would like to have a look before merging? Else it is now good for me.

Copy link
Contributor

@DirkEilander DirkEilander left a comment

Choose a reason for hiding this comment

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

Thanks for this huge effort and great contribution @savente93 and @hboisgon

  • I've made one PR for the cookiecutter (which I believe has already been merged)
  • The docs contain an amazing level of detail and information. I'm really happy you took the time to write this down. I think it could still benefit from some restructuring though by 1) moving some general aspects to elsewhere in model section of the user guide; and 2) splitting it into basic and advanced topics
  • Some conventions would be good to discuss, see specific comments below.
  • A lot of the comments are simple typos, you can select these and commit in a batch commit.

docs/_static/model_building_process.png Outdated Show resolved Hide resolved
docs/api.rst Outdated Show resolved Hide resolved
docs/dev/plugin-quickstart.rst Outdated Show resolved Hide resolved
docs/dev/plugin-quickstart.rst Outdated Show resolved Hide resolved
docs/dev/plugin-quickstart.rst Outdated Show resolved Hide resolved
docs/dev/plugin-quickstart.rst Outdated Show resolved Hide resolved
docs/dev/plugin-quickstart.rst Outdated Show resolved Hide resolved
docs/dev/plugin-quickstart.rst Show resolved Hide resolved
docs/dev/plugin-quickstart.rst Outdated Show resolved Hide resolved
docs/dev/plugin-quickstart.rst Outdated Show resolved Hide resolved
@savente93
Copy link
Contributor Author

@hboisgon I tried to take care of as many issues as I could but there are a couple of comments that I'm not sure how to respond to. Could you take another look please?

@savente93
Copy link
Contributor Author

@DirkEilander I've resolved your comments as best I could and also done some light editing. Could you take another look?

@DirkEilander
Copy link
Contributor

@DirkEilander I've resolved your comments as best I could and also done some light editing. Could you take another look?

Thanks @savente93! I've done a final check and happy for it to be merged.
Let's await some feedback from new developers to see how we improve and whether for instance a notebook could help.

@savente93 savente93 merged commit feea433 into main Sep 21, 2023
4 checks passed
@savente93 savente93 deleted the plugin-quickstart branch September 21, 2023 07:40
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

Successfully merging this pull request may close these issues.

No link to the EVA notebook in the docs DOC: Add a page with tips to start your own plugin
3 participants