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.

Sign up for GitHub

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

👋 Welcome page #30

Merged
merged 3 commits into from
Jun 16, 2023
Merged

👋 Welcome page #30

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
40dd64a
👋 Welcome page
rowanc1 Oct 7, 2022
1b40b4e
Update to mystmd.org
rowanc1 Jun 15, 2023
fa87dba
Update profile/README.md
rowanc1 Jun 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Executable Books

The Executable Books Project is an international collaboration to build open source tools that facilitate publishing computational narratives using the Jupyter ecosystem.

We are a community who steward:
Copy link
Member

Choose a reason for hiding this comment

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

The last few months have made me believe we should be more precise in our description of the EBP project and its (current) organizational structure. I think it's more accurate to say we are a project, funded by the Sloan Foundation, the is building open source technology. We aspire to becoming a community-driven project, but we are currently largely a single project team (e.g., everybody in the team page is either a Principle Investigator or has been paid to work on this except for one person).


- [Jupyter Book](https://jupyterbook.org): Build beautiful, publication-quality books and documents from computational material like Jupyter Notebooks.
- [MyST Markdown](https://myst.tools): An extended Markdown format designed for the future of technical communication and publication.

As well as many, many other tools for parsing, headless execution of Jupyter Notebooks ([caching](https://github.com/executablebooks/jupyter-cache) and in the [browser](https://github.com/executablebooks/thebe)), popular sphinx extensions (e.g. [copy-button](https://github.com/executablebooks/sphinx-copybutton), [sphinx-design](https://github.com/executablebooks/sphinx-design), [sphinx-thebe](https://github.com/executablebooks/sphinx-thebe)), and many [scientific templates](https://github.com/myst-templates) for writing journal articles and presentations.
rowanc1 marked this conversation as resolved.
Show resolved Hide resolved

## Contribute to a Project 👩‍💻
Copy link
Member

Choose a reason for hiding this comment

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

For example, I suggest that we make this more explicit and list-like. IMO our goal should be to route people to other documentation quickly that has more information. Something like:

See below for several ways that you can interact with this project and its team.

- [Our discussion forum](link) is where we share questions, ideas, and discuss broad issues related to the project.
	- <note: the discussion forum should then have a top-level link that explains its structure, what kind of information happens there, etc> 
- [Our team meetings](link) are a way for the project's core team and community to discuss and share important topics that benefit from real-time discussion. They are open for anybody to join.
- [Our twitter account](link) is used to share information about the project and what goes on in its community.

I think that this list should be fairly minimal, and should defer to a single source of truth about things like "when are the meetings and what are their topics", or "what is in the forum".


[Ask a question](https://github.com/orgs/executablebooks/discussions) or [show and tell](https://github.com/orgs/executablebooks/discussions/categories/show-and-tell) the community about your project or use of MyST, or come to a [monthly team meeting](https://executablebooks.org/en/latest/meetings/index.html).

All of our projects are open source and welcome and and all contributions -- from documenting problems you run into, adding to documentation, [telling people](https://twitter.com/executablebooks) about your project and our mission, and _of course_ contributing to the code! Please review our [Code of Conduct](../CODE_OF_CONDUCT.md) to learn about some of the conventions we follow.
Copy link
Member

Choose a reason for hiding this comment

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

We should put the code of conduct in a dedicated header above "Contribute to a project".

e.g.:

## Code of Conduct

By participating in any space stewarded by the Executable Books Project, you must follow our [Code of Conduct](link). Please review its content and the processes we have for enforcement. However, note this CoC is aspirational, as the project is transitioning to be more inclusive, and is still developing its culture and CoC procedures.


## Be inspired, build a book ✨📖✨

Our [Gallery of Jupyter Books](https://executablebooks.org/en/latest/gallery.html) has contributions from across the community. See the [Jupyter Book documentation](https://jupyterbook.org/en/stable/intro.html) to get up and running to create your first online book, with executable, interactive content.

## Learn about MyST Markdown ✍️👩‍🔬

Visit <https://myst.tools> to see an interactive demo of working with MyST -- an extensible and powerful markup language for technical writing. You can use it to [create books](https://jupyterbook.org/), write [scientific papers](https://js.myst.tools/guide/creating-pdf-documents), or use [MyST in JupyterLab](https://github.com/executablebooks/jupyterlab-myst).

## About the project ℹ️

Learn more about our project’s [goals and strategy](https://executablebooks.org/en/latest/about.html), see a list of core [team members](https://executablebooks.org/en/latest/team.html), and come to our [next team meeting](https://executablebooks.org/en/latest/meetings/index.html).