-
Notifications
You must be signed in to change notification settings - Fork 91
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
Fixup broken links in docs #777
Conversation
[How-To Authenticate with earthaccess](/howto/authenticate.md) | ||
[Getting Started Tutorial](/tutorials/getting-started.ipynb) | ||
|
||
* [Quick start](../../quick-start/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "getting started" tutorial doesn't appear to exist anymore, so I linked to the 'quick-start'.
I'm noticing now that the other "user guide" pages also have this problem. I also just noticed another broken link on this page: https://earthaccess.readthedocs.io/en/latest/howto/search-granules/ ("Introducing NASA earthaccess" tutorial link). |
I updated those pages w/ new commits to this PR.
I'm not sure what this is supposed to link to. The URL is https://nsidc.github.io/earthaccess/tutorials/demo/#querying-for-datasets, but I do not see any "demo" directory under tutorials. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thank you, Trey :)
I wonder why our build process didn't catch these broken links. It caught others! 🤔 Anyway, congrats on opening lucky PR #777 🥳 |
Fixes a couple of broken links that I came across while browsing the
earthaccess
documentation. Resolves #778contributing documentation
before getting started.
title such as "Add testing details to the contributor section of the README".
example
closes #1
. SeeGitHub docs - Linking a pull request to an issue.
CHANGELOG.md
with details about your change in a section titled## Unreleased
. If such a section does not exist, please create one. FollowCommon Changelog for your additions.
README.md
with details of changes to theearthaccess interface, if any. Consider new environment variables, function names,
decorators, etc.
Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub
once these requirements are fulfilled. Don't worry if you see any test failures in
GitHub at this point!
Pull Request (PR) merge checklist - click to expand
Please do your best to complete these requirements! If you need help with any of these
requirements, you can ping the
@nsidc/earthaccess-support
team in a comment and wewill help you out!
Request containing "pre-commit.ci autofix" to automate this.
📚 Documentation preview 📚: https://earthaccess--777.org.readthedocs.build/en/777/