-
Notifications
You must be signed in to change notification settings - Fork 85
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
Conversation
Decisions from hack day;
|
Add content about hack days to our docs
Co-authored-by: Andy Barrett <andypbarrett@gmail.com>
Co-authored-by: Andy Barrett <andypbarrett@gmail.com>
Co-authored-by: Andy Barrett <andypbarrett@gmail.com>
Co-authored-by: Andy Barrett <andypbarrett@gmail.com>
Co-authored-by: Jennifer Tran <12633533+botanical@users.noreply.github.com>
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.
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!
All, @asteiker asked for a chance to review, please hold off on merging until then. |
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.
@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). |
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.
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!
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.
I wonder if that was a copy-paste mistake?
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.
@mfisher87 If not discussions, what should it be? Issues?
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. |
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>
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/