Creating quick start guide as part of overall docs improvements #249
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hCraker
added
documentation
hCraker
added
work in progress
and removed
ready for review
added 6 commits
September 12, 2022 15:05
…hange later once reorganization is complete
hCraker
added
ready for review
anissa111
reviewed
Sep 14, 2022
|
@hCraker I included that one comment above for something I saw immediately, but I'd really like to be able to check out the rendered RTD pages. Could you merge the docs branch in to this branch to pull over the fix? |
erogluorhan
reviewed
Sep 14, 2022
erogluorhan
reviewed
Sep 14, 2022
anissa111
reviewed
Sep 15, 2022
docs/getting_started/overview.rst
Outdated
| GeoCAT-comp's open-source nature allows for more community engagement than a traditional software development workflow | ||
| does. As advances are made in the realm of geoscience, new tools will be needed to analyze new datasets. We are dedicated | ||
| to addressing user needs and encourage users to submit feature requests and contributions to our GitHub as well as | ||
| participate in discussions. See our `support <support>`_ page for info on how to submit bug reports and requests and how to get involved. |
There was a problem hiding this comment.
Suggested change
| participate in discussions. See our `support <support>`_ page for info on how to submit bug reports and requests and how to get involved. | |
| participate in discussions. See our `support <support>`_ page for info on how to submit bug report, feature requests, and how to get involved. |
There was a problem hiding this comment.
You're right this needs rewording. How does this sound?
See our
support <support>_ page for info on how to submit bug reports, request new
features, and get involved.
anissa111
reviewed
Sep 15, 2022
anissa111
reviewed
Sep 15, 2022
anissa111
reviewed
Sep 15, 2022
| @@ -65,3 +66,4 @@ extra: | |||
| - erogluorhan # O. Eroglu https://github.com/erogluorhan | |||
| - anissa111 # A. Zacharias https://github.com/anissa111 | |||
| - michaelavs # M. Sizemore https://github.com/michaelavs | |||
| - hcraker # H. Craker https://github.com/hcraker | |||
There was a problem hiding this comment.
We're going to be removing this file here soon, you should add this change to the feedstock repo instead!
anissa111
reviewed
Sep 15, 2022
docs/getting_started/examples.rst
Outdated
Comment on lines
5
to
9
| Usage Examples | ||
| ============== | ||
|
|
||
| Short Tutorial | ||
| -------------- |
There was a problem hiding this comment.
I don't think we need both headers if we're going to drop the second subhead. Maybe we could do something like:
Suggested change
| Usage Examples | |
| ============== | |
| Short Tutorial | |
| -------------- | |
| Quick Start Examples | |
| -------------------- | |
| For more comprehensive examples, go check out :ref:`examples` |
Disclaimer: I have no idea if that linkage will actually work
anissa111
reviewed
Sep 15, 2022
docs/getting_started/examples.rst
Outdated
|
|
||
| Short Tutorial | ||
| -------------- | ||
| Calculate saturation vapor pressure from :code:`Numpy` Data:: |
There was a problem hiding this comment.
Suggested change
| Calculate saturation vapor pressure from :code:`Numpy` Data:: | |
| Calculate saturation vapor pressure from ``numpy`` data:: |
Thankfully, we don't have to do the full code directive to get this notation anymore
anissa111
reviewed
Sep 15, 2022
docs/getting_started/overview.rst
Outdated
| GeoCAT-comp's open-source nature allows for more community engagement than a traditional software development workflow | ||
| does. As advances are made in the realm of geoscience, new tools will be needed to analyze new datasets. We are dedicated | ||
| to addressing user needs and encourage users to submit feature requests and contributions to our GitHub as well as | ||
| participate in discussions. See our `support <support>`_ page for info on how to submit bug reports and requests and how to get involved. |
There was a problem hiding this comment.
This link here actually doesn't work. I think you might want to do something like :ref:support
Edit: Sorry, I can't get the formatting right on the comment. I'm talking about this: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html
anissa111
reviewed
Sep 15, 2022
docs/getting_started/overview.rst
Outdated
| they are based upon is wrapped in Python in the GeoCAT-f2py (Fortran 2 Python) package. GeoCAT-f2py is imported by | ||
| GeoCAT-comp and included in the GeoCAT-comp namespace. Simply, this means that GeoCAT-f2py functions can be called | ||
| through GeoCAT-comp, so there is no need for users to import GeoCAT-f2py directly in their scripts. Information about | ||
| GeoCAT-f2py can be found on the `package's homepage <https://geocat-f2py.readthedocs.io/en/>`_. |
There was a problem hiding this comment.
Ahh, my bad, apparently RTD doesn't like that link. Let's do:
Suggested change
| GeoCAT-f2py can be found on the `package's homepage <https://geocat-f2py.readthedocs.io/en/>`_. | |
| GeoCAT-f2py can be found on the `package's homepage <https://geocat-f2py.readthedocs.io/>`_. |
added 6 commits
September 16, 2022 10:40
anissa111
reviewed
Sep 16, 2022
erogluorhan
reviewed
Sep 17, 2022
docs/getting_started/overview.rst
Outdated
| functions in pure Python. With so many tools being used under the hood, GeoCAT-comp users have access to geoscience | ||
| specific computational tools without needing extensive working knowledge of `Pangeo <https://pangeo.io/>`_ stack. | ||
|
|
||
| There are syntactical benefits to using the Pangeo stack, once of which is indexing by label. NCL requires the |
Co-authored-by: Anissa Zacharias <[email protected]>
anissa111
approved these changes
Sep 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #240
Part of prep for October tutorial #239
Addresses part of overall doc improvements #245