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

Improve documentation structure #498

Merged
merged 63 commits into from
May 8, 2024
Merged

Improve documentation structure #498

merged 63 commits into from
May 8, 2024

Conversation

andypbarrett
Copy link
Collaborator

@andypbarrett andypbarrett commented Mar 19, 2024

This is the start of reorganizing and completing the documentation for earthaccess.

I have reorganized the first page of the docs to show a bare-bones example of authentication, granule search and download, to get people started.

I will focus on user-guides for the API methods starting with:

  • login
  • search_datasets
  • search_data
  • download
  • open

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

@mfisher87
Copy link
Collaborator

Decisions from hack day;

  • Break up the “Welcome” page to multiple pages
  • Remove/summarize/link to license/LoS info
  • Glossary -> User Guide Overview

Co-authored-by: Jennifer Tran <12633533+botanical@users.noreply.github.com>
@mfisher87 mfisher87 changed the title Update documentation Update documentation structure May 1, 2024
@mfisher87 mfisher87 changed the title Update documentation structure Improve documentation structure May 1, 2024
Copy link
Contributor

@botanical botanical left a comment

Choose a reason for hiding this comment

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

Love the syntax highlighting in the code blocks ✨ As far as I can tell, these changes seem solid to me. Thanks for tagging for review 😄 Hopefully someone else can review it as well!

@mfisher87 mfisher87 requested a review from asteiker May 4, 2024 00:09
@mfisher87
Copy link
Collaborator

mfisher87 commented May 4, 2024

All, @asteiker asked for a chance to review, please hold off on merging until then.

README.md Show resolved Hide resolved
Copy link
Member

@asteiker asteiker left a comment

Choose a reason for hiding this comment

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

@andypbarrett I have quite a few comments here, most of which are nits. I think most are fairly quick (typos and smaller suggestions) but if there's anything that requires more discussion, I don't feel it warrants a hold on the merge. Happy to pull comments out into a new Issue(s) - lmk either way.


> Please see the [Contributing Guide](CONTRIBUTING.md).

### [Project Board](https://github.com/nsidc/earthdata/discussions).
Copy link
Member

Choose a reason for hiding this comment

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

Do we view the Discussions as our project board? I'm wondering if we want to describe this more like:

Discussion topics, including new feature ideas, announcements, and Q&A can be found in our Discussions.

Separately, I'm wondering if there's interest in building out a Roadmap and community project board for earthaccess. If so we could build it and add to the readme here!

Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder if that was a copy-paste mistake?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@mfisher87 If not discussions, what should it be? Issues?

README.md Show resolved Hide resolved
docs/contributing/development.md Outdated Show resolved Hide resolved
docs/contributing/our-meet-ups.md Outdated Show resolved Hide resolved
docs/howto/access-data.md Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/quick-start.md Outdated Show resolved Hide resolved
docs/user_guide/index.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@asteiker
Copy link
Member

asteiker commented May 7, 2024

Also @andypbarrett @MattF-NSIDC These restructured docs are really fantastic - this is excellent work!! The organization is much improved and it really feels like the scaffolding is in place to easily build and continue to improve from here.

mfisher87 and others added 10 commits May 6, 2024 22:40
Co-authored-by: Amy Steiker <47193922+asteiker@users.noreply.github.com>
Co-authored-by: Amy Steiker <47193922+asteiker@users.noreply.github.com>
Co-authored-by: Amy Steiker <47193922+asteiker@users.noreply.github.com>
Co-authored-by: Amy Steiker <47193922+asteiker@users.noreply.github.com>
Co-authored-by: Amy Steiker <47193922+asteiker@users.noreply.github.com>
Co-authored-by: Amy Steiker <47193922+asteiker@users.noreply.github.com>
Co-authored-by: Amy Steiker <47193922+asteiker@users.noreply.github.com>
Co-authored-by: Amy Steiker <47193922+asteiker@users.noreply.github.com>
Co-authored-by: Amy Steiker <47193922+asteiker@users.noreply.github.com>
asteiker
asteiker previously approved these changes May 8, 2024
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.

Run mkdocs with --strict flag to catch e.g. docstring parameters out of sync with function parameters
4 participants