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

Fixup broken links in docs #777

Merged
merged 3 commits into from
Jul 30, 2024
Merged

Fixup broken links in docs #777

merged 3 commits into from
Jul 30, 2024

Conversation

trey-stafford
Copy link
Contributor

@trey-stafford trey-stafford commented Jul 30, 2024

Fixes a couple of broken links that I came across while browsing the earthaccess documentation. Resolves #778

  • Please review our
    contributing documentation
    before getting started.
  • Ensure an issue exists representing the problem being solved in this PR.
  • Populate a descriptive title. For example, instead of "Updated README.md", use a
    title such as "Add testing details to the contributor section of the README".
  • Populate the body of the pull request with:
  • Update CHANGELOG.md with details about your change in a section titled
    ## Unreleased. If such a section does not exist, please create one. Follow
    Common Changelog for your additions.
  • Update the documentation and/or the README.md with details of changes to the
    earthaccess 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 we
will help you out!

  • Add unit tests for any new features.
  • Apply formatting and linting autofixes. You can add a GitHub comment in this Pull
    Request containing "pre-commit.ci autofix" to automate this.
  • Ensure all automated PR checks (seen at the bottom of the "conversation" tab) pass.
  • Get at least one approving review.

📚 Documentation preview 📚: https://earthaccess--777.org.readthedocs.build/en/777/

@trey-stafford trey-stafford marked this pull request as ready for review July 30, 2024 19:27
[How-To Authenticate with earthaccess](/howto/authenticate.md)
[Getting Started Tutorial](/tutorials/getting-started.ipynb)

* [Quick start](../../quick-start/)
Copy link
Contributor Author

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'.

@trey-stafford
Copy link
Contributor Author

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).

@trey-stafford trey-stafford changed the title Fixup broken links in authentication user guide Fixup broken links in docs Jul 30, 2024
@trey-stafford
Copy link
Contributor Author

I'm noticing now that the other "user guide" pages also have this problem.

I updated those pages w/ new commits to this PR.

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'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.

Copy link
Collaborator

@mfisher87 mfisher87 left a 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 :)

@mfisher87 mfisher87 merged commit f0980a2 into main Jul 30, 2024
16 checks passed
@mfisher87 mfisher87 deleted the fixup-broken-links branch July 30, 2024 22:23
@mfisher87
Copy link
Collaborator

I wonder why our build process didn't catch these broken links. It caught others! 🤔

Anyway, congrats on opening lucky PR #777 🥳

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.

Links broken in docs
2 participants