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

Contributor guides #3

Open
4 of 6 tasks
khider opened this issue Nov 3, 2023 · 2 comments
Open
4 of 6 tasks

Contributor guides #3

khider opened this issue Nov 3, 2023 · 2 comments

Comments

@khider
Copy link
Member

khider commented Nov 3, 2023

Use the Purpose page for the guide

  • We need to explain the difference between LifeHacks and Science Bits and whether they are necessary for contribution. Not binding.
  • Writing a part on how to write the .yml file. [Work with @khider to write the guide, test with @CommonClimate]
  • Dependencies should contain paragraphs about software packages that are used in the Books (specifically LinkedEarth) and link to their docs/tutorials.
  • Remove Usage
  • Credit and Inspiration - Mention Pangeo and Project Pythia
  • Exercises - Remove
@khider khider added this to the Fall Hackathon milestone Aug 23, 2024
@CommonClimate
Copy link

@jordanplanders it seems like we are pretty close to closing this. Can you complete the checklist and close, or give a status update as to why we can't do that yet?

@jordanplanders
Copy link
Contributor

@CommonClimate I reworked the idea of "parts" to be optional content categories (both in the contributor guide and the code base) and update the guide with more details about the different kinds of information on the cards and how that information is pulled from the various yml files.

That said, I think this issue is not ready to be closed. In addition to supplemental information about packages, I think we still need:

  • template chapter_meta.yml files available from the paleobooks website repo
  • core list of tags and notes about tagging practices

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

No branches or pull requests

3 participants