The-turing-way: Replace markdown formatting with MyST markdown formatting of Jupyter Book for images: Guide for Guide for Community Handbook

Created on 15 Oct 2020 · 6Comments · Source: alan-turing-institute/the-turing-way

:tada::balloon::cake: Welcome Hacktober Contributors! This is The Turing Way repository :cake::balloon::tada:

:dizzy::hatched_chick::sunny: _We're excited that you're here and want to contribute._ :sunny::hatched_chick::dizzy:

Summary of Issue

Partly related to #1313

_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

Please pick a chapter listed below (available in this folder) and update the image formatting to MySt Markdown in all its files where the image has been used.
- If the image has been listed in #1313, please also update the size (lower than 1MB) if you can, and check it off in the issue description
[ ] Code of Conduct
[ ] Style Guide
[ ] Acknowledging Contributors
[ ] Monthly Newsletters
[ ] Book Dash Events
[ ] Community Coworking Calls

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.

Hacktoberfest jupytercon2020 markdown

Source

malvikasharan

All 6 comments

@malvikasharan I would like to work on this issue.

ikayz on 27 Oct 2020

🚀1

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

malvikasharan on 27 Oct 2020

👍1

@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?

ikayz on 29 Oct 2020

👍1

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!