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

Package exposure items #30

Open
darribas opened this issue May 1, 2020 · 3 comments
Open

Package exposure items #30

darribas opened this issue May 1, 2020 · 3 comments

Comments

@darribas
Copy link
Member

darribas commented May 1, 2020

Starting this issue to discuss ideally how to structure information and meta data about each package so it's easier to consume in "aggregators" (meta-website, notebooks project, etc.). Looping also @knaaptime as per call discussion.

@darribas
Copy link
Member Author

darribas commented May 1, 2020

From the notebooks project, elements that could immediately improve the appearance include:

  • Standard way of storing images present in the README which gets pulled at the introduction of each package notebooks.
  • Going forward, it might be worth thinking whether we want something different from the README to be the introduction. Maybe a short description of the pacakge, what it does and key links? This sounds like what the README should be, but maybe it's different in some contexts. Maybe something like a BLURB.md file which could also be pulled on the website?

@weikang9009
Copy link
Member

Sounds like a great idea.
We might also want to make sure we are using the same file format for README, .md or .rst.

@jGaboardi
Copy link
Member

Linking the agenda notes where this was originally discussed.

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