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

Replace markdown formatting with MyST markdown formatting of Jupyter Book for images: Guide for Guide for Community Handbook #1417

Closed
6 tasks
malvikasharan opened this issue Oct 15, 2020 · 6 comments
Labels
Hacktoberfest These issues or PRs maybe relevant for Hacktoberfest contributors. jupytercon2020 This labels indicates issues and PRs interesting for the JupyterCon 2020 sprint attendees. markdown These issues or PR are related to a Markdown format file.

Comments

@malvikasharan
Copy link
Collaborator

malvikasharan commented Oct 15, 2020

πŸŽ‰πŸŽˆπŸ° Welcome Hacktober Contributors! This is The Turing Way repository πŸ°πŸŽˆπŸŽ‰

πŸ’«πŸ₯β˜€οΈ We're excited that you're here and want to contribute. β˜€οΈπŸ₯πŸ’«

Summary of Issue

The Turing Way book is built on JupyterBook that uses MyST markdown, which allows images to adjust as per the screen size and be cross-referenced inside the book. See our style guide for details.

We would like to replace all standard markdown syntax (![alt text](image location)) with MySt markdown syntax in The Turing Way as described here: See our style guide for details.

What needs to be done

Who can help

Anyone who would like to participate in Hacktoberfest or contribute to The Turing Way GitHub repository for the first time easier to do locally (by git) but not mandatory

About Hacktober and The Turing Way

Hacktoberfest is a month-long celebration of Open Source Projects where the goal is to make 4 Pull Requests during the month.

A bit about Git

If you’re new to git then here are some instructions to help you get going. Remember that you can ask us any questions you need to along the way.

A Pull Request (what Hacktober is measured on) lets you tell others about changes you've pushed to a branch in a repository on GitHub. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before your changes are merged into the base branch.

In this issue, we’ve outlined what needs to be done, and how you can go about addressing it. Once the issue has been addressed, you can submit a Pull Request for review (tell us what you’ve done) and we can incorporate it into The Turing Way.

We’ve also created this special Hacktoberfest tag to make it easy for you to find other places to contribute if you’re new.
In the spirit of Hacktoberfest, please only do a few of these to submit your PR so that we can learn and grow as a community together.

Our Community

We want to ensure that every user and contributor feel welcome, included, and supported to participate in The Turing Way community. We welcome all contributions to this project via GitHub issues and pull requests. Please read our Contributors document and our Code of Conduct while you engage in The Turing Way. As you start contributing to The Turing Way, don't forget that your ideas are more important than perfect pull requests. ❀️

If you have any questions that aren't discussed below, please let us know through one of the many ways to get in touch.

@malvikasharan malvikasharan added Hacktoberfest These issues or PRs maybe relevant for Hacktoberfest contributors. markdown These issues or PR are related to a Markdown format file. jupytercon2020 This labels indicates issues and PRs interesting for the JupyterCon 2020 sprint attendees. labels Oct 15, 2020
@ikayz
Copy link
Contributor

ikayz commented Oct 27, 2020

@malvikasharan I would like to work on this issue.

@malvikasharan
Copy link
Collaborator Author

Hey @ikayz. Please go ahead and give it a try :) You can tag me in your PR or invite a review from @paulowoicho.

@ikayz
Copy link
Contributor

ikayz commented Oct 29, 2020

@malvikasharan I looked at the chapters and didn't find any images being used except examples which were in backtick quotes, or maybe I'm missing something?

@paulowoicho
Copy link
Collaborator

Hi @ikayz. I have had a look through the chapters and confirmed that all the images they contain are indeed formatted in MyST, but you can go ahead and resize any of the images that are above 1MB as per issue #1313. You can also tag me to review your PR when you're done!

@ikayz
Copy link
Contributor

ikayz commented Oct 29, 2020

@paulowoicho awesome. There are other issues I would also like to work on, #1407 #1409

@paulowoicho
Copy link
Collaborator

Yes, please go ahead! Thank you for all your contributions!

@paulowoicho awesome. There are other issues I would also like to work on, #1407 #1409

@da5nsy da5nsy closed this as completed Nov 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest These issues or PRs maybe relevant for Hacktoberfest contributors. jupytercon2020 This labels indicates issues and PRs interesting for the JupyterCon 2020 sprint attendees. markdown These issues or PR are related to a Markdown format file.
Projects
None yet
Development

No branches or pull requests

4 participants