Skip to content

Latest commit

 

History

History
211 lines (166 loc) · 9.85 KB

CONTRIBUTING.md

File metadata and controls

211 lines (166 loc) · 9.85 KB
Raw

Guide to Contributing

How to contribute to the scikit-learn.org blog.

Table of Contents

Blog Standards

This section contains information around the scikit-learn blog's standards and guidelines.

Categories & Tags

Categories and Tags help us organize our blog by grouping related content to make it easier to discover.

⚠️NOTE⚠️ Individual Category (blog/category/name.md) and Tag (blog/tag/name.md) pages are automatically generated by a Github Action. Please do not manually add add markdown pages.

Categories

Categories are broad groupings of posts. A post should have only one category. If the post could potentially fall under multiple categories, please select the one that best describes it.

   Example Categories: Updates, Events, Team

Tags

Tags describe specific details of a post. They help to link related posts together and aid in user search. A post can have multiple tags or no tags. While there is no strict limit, we recommend using no more than 10 tags per post.

   Example Tags: Sprints, Community, Open Source, New Member, Machine Learning, New Feature

Installation

Instructions to build and test the blog.scikit-learn.org site locally.

Installing Ruby & Jekyll

If this is your first time using Jekyll, please follow the Jekyll docs and make sure your local environment (including Ruby) is setup correctly.

Deployment

To run the theme locally:

  1. Navigate to the theme directory and run bundle install to install the dependencies (if you get errors, delete Gemfile.lock and try again).
  2. Next, run jekyll serve or bundle exec jekyll serve to start the Jekyll server.
  3. Visit the site in your browser via http://localhost:4000.

For more information, check the Deployment Methods page on the Jekyll website.

Theme Documentation

This blog is uses the Minimal Mistakes Jekyll Theme. For more information on configuration/customization, please reference the theme documentation.

Adding a New Post

Setup

This sections contains instructions to add a new blog post to the scikit-learn blog.

Before adding a post, you must have:

  • A Github account

Submitting Your Blog Post

Refer to the blog post template.

  1. First, fork the scikit-learn/blog repository.
  2. Within your forked repository, make a copy of the Blog Post Template.
  3. Go to Pull Requests and do a New Pull request.
  4. Create a pull request.

Formatting Your Blog Post

1) Update the Post's Front Matter

The purpose of front matter is to set variables and metadata on the site's pages.

Click to Expand

  1. Add Post Information

    • title: Add the title of your blog post in double quotes,
      • title: "Example Post Title" (with quotes)
    • date: Add the date of posting. This helps to ensure our blog displays posts are sorted correctly and are displayed in a sequential order.
      • date: Month Name, Day, Year (no quotes)

  2. Add Post Category and Tags: Categories and tags help us organize our blog by grouping related content to make it easier to discover. Check the Blog Standards section for more information.

    • categories: A post should have only one category. Format categories in titlecase without dashes (Ex. "Open Source" instead of "open-source")
    • tags: Tags describe specific details of a post. They help to link related posts together and aid in user search.
    • categories_tags

  3. Add Featured Image

    • featured-image: First, place the image in the assets/images/posts_images/ folder. Set the featured-image variable to the base image name, omiting the full path.
      • featured-image: image-name.png (no quotes)

  4. Add Author Information

    • The postauthors field can accomodate multiple authors. Each postauthor can use the following four variables, but only the name field is required.
      • name: (required)
        • name: Author Name (no quotes)
      • website: (optional) Link attached to author name. Can be any relevant link.
        • website: https://github.com (no quotes)
      • email: (optional) Appears as an email icon after author name.
      • image: (optional) Author headshot, appears before author name. First, place the image in the assets/images/author_images/ folder. Set the image variable to the base image name, omiting the full path.
        • image: image-name.png (no quotes)
      • Single Author Post Multiple Author Post

2) Add post content.

You can format your post using Markdown. Click to expand to view basic formatting suggestions or visit the Markdown Guide for more examples.

Click to Expand

Headings

Use the # symbol to format header text.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Text Emphasis

Use the * or _ symbols around words or phrases to add bolding or italics, or even bold within italics!

_Italic text_
*Italic text*
__Bold text__
**Bold text**
_You can even add **bold text** within italics_

Lists

Add unordered lists:

- Item 1
- Item 2

Or ordered lists:

1. Item 1
2. Item 2

If you are adding paragraphs between list items, be sure to indent each paragragh by four spaces.

1. Item 1
    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Feugiat in fermentum posuere urna nec. Nibh tellus molestie nunc non blandit. Dui id ornare arcu odio ut sem nulla. 
    Non curabitur gravida arcu ac. Ut sem viverra aliquet eget sit amet. Morbi tincidunt ornare massa eget egestas purus viverra accumsan in. Vulputate eu scelerisque felis imperdiet proin fermentum leo vel. Tincidunt augue interdum velit euismod in pellentesque massa. Interdum velit laoreet id donec ultrices tincidunt.
2. Item 2

Links

Add a link with custom text.

[link text](https://url.com)

Images

There are a few ways to add images to your post. First, place the image in the /assets/images/posts_images/ folder, then adding the following code.

Add an Image
![](/assets/images/posts_images/sample-image.png)
Customize Image Size

Adjust the width and height of your image.

<img src="/blog/assets/images/posts_images/sample-image.png" width="200" height="100">
Add an Image Caption
  • Within img src, replace sample-image.jpg with the name of the image and update the alt to be a short (2-4 word) description of the image.
  • Update the Photo Credit caption-link and replace Credit Link Text with the source name.
<figure>
  <img src="/blog/assets/images/posts_images/sample-image.jpg"
       alt="short description" max-width="50%" max-height="50%" /> 
  <figcaption>
    Photo Credit: <a href="https://caption-link.com">Credit Link Text</a>
  </figcaption>
</figure>
Add a Link to an Image

Update the image_link. The Hover Text will be shown when a mouse hover's over the image.

[![](/blog/assets/images/posts_images/sample-image.jpg "Hover Text")](https://image-link.com)

Text Highlighting

<span style="background-color: #CAE9F5;">
  [Data Umbrella Interview: Juan Martín Loyola](https://blog.dataumbrella.org/jmloyola-opensource-experience)             
</span>