Developing on the Global PyLadies Website¶

Editing¶

To make your location show up on our locations page, create an entry under chapters.

Here are the available configuration items you can set, and what they mean/show up as on the locations page.

A complete example:

- name: Austin, TX
  meetup_id: 5947662
  website: atx.pyladies.com
  image: pyladies_atx.jpeg
  email: atx@pyladies.com
  twitter: pyladiesATX
  meetup: pyladies-atx
  location:
      latitude: 30.2711286
      longitude: -97.7436995

Make sure a tick, - precedes the name: attribute (in yaml syntax, it symbolizes another item in a list).

It shows up on the locations page as its own little "card":

Attributes¶

name¶

required The name attribute sets the name to show up on the locations page. You can as verbose or minimal as you'd like:

meetup_id¶

optional The meetup_id actually corresponds to the Meetup Widget on the website. The code for the Meetup Widget can be found here.

website¶

optional The website attribute is the absolute URL for the location's website, or the relative URL for your location's page (e.g. atx for pyladies.com/locations/atx).

注釈

If it is an absolute URL - e.g. it is not relative to the pyladies.com domain (e.g. pyladies.com/locations/atx) but is a subdomain (e.g. atx.pyladies.com), the external_website attribute needs to be set to True.

external_website¶

required if location has a subdomain A boolean flag (if not set, will default to False) for when the location has a subdomain.

image¶

required The image attribute is the filename of the location's image that should be placed in the www/_assets/images/ directory. You can use a standard one that's already in the repository, or adapt the logo to your location (see Logos).

email¶

required The email attribute is the location's email address.

twitter¶

github¶

facebook¶

google_plus¶

optional The twitter, facebook, google_plus, and github attributes are links to the location's handle/account. You may set as many as you'd like, or none. If your group uses other social media accounts that you want to publish, please read Adding New Link Types.

meetup¶

optional The meetup is the Meetup group's URL name - the string that comes after www.meetup.com/. If your group uses a different service than Meetup.com for event publishing (other than your own location's website), please read Adding New Link Types.

location¶

required The location attribute is a map of latitude and longitude. If this is set, it will add a pinpoint to the map at the top of the page. It will automatically pull in all the information, too.

Step 1: Pick a Config Attribute¶

We'll do a full example. Let's say that Twitter was not already there, and we wanted to add it.

We should start by picking a good config attribute (similar to the Attributes above). A good config attribute here would be simply twitter:

- name: A New PyLadies City, Foo
  twitter:  twitter.com/foo-pyladies

Step 2: Pick an Icon¶

We currently already use entypo. If you find an icon that you'd like to use that entypo already has, take note of its name. You can do this by right-clicking the icon you like on the entypo site and select "Inspect Element" to see the name of it:

The icon name here would be twitter (not including the .svg or images/).

If entypo doesn't have an icon that matches your social network, or that you like, read on to Adding non-Entypo Icons.

Step 3: Add Icon to HTML Template¶

Next, in your text editor, open up the location's template file, www/locations/index.html. Then, where it says <h3 class="chpts social-icons"> add the Jinja template information.

The following example uses the above twitter icon previously selected:

{% if chapter.twitter %}
    <a href="{{ chapter.twitter }}" title="Twitter Link"><i class="twitter"></i></a>
{% endif %}

The {% if chapter.twitter %} checks to see if there's a config attribute set for a chapter, and if it is, it will create a link using the value that is set.

Notice <i class="twitter"></i> - this will actually put the icon (named twitter, which we figured out in the previous step) there, and make a link.

Step 4: Add your Config, Commit, & Push!¶

Save your edits, and test to see if it looks okay (refer to Using mynt for how to test your changes).

If all looks good, then commit, push to your fork of the PyLadies repository, then submit a pull request!

Adding non-Entypo Icons¶

If your icon isn't made by entypo, you don't like any of them, or found an icon elsewhere (e.g. FontAwesome), follow their instructions for setting up their icons.

You still must follow Step 3: Add Icon to HTML Template for the icon to show up in the template. The Jinja2 syntax is the same (e.g. {% if chapter.twitter %} or {{ chapter.twitter }}), but the HTML to represent the icon itself may be different. Again, refer to their particular instructions.

Topics¶

We're looking for posts about Python and the ladies doing cool things with it. Our audience includes both experts and newer programmers. If you're writing a more expert level post, consider pointing newer programmers to resources to get started with.

Attribution¶

Cite your sources! Either link to them in your post, or the old-fashioned academic Chicago MLA style of "quoting someone's work"(FooPyLady) with an entry for "FooPyLady" at the bottom of your post (or any other MLA styling).

Also Please include whether:

1. You want to be noted as the author
2. If so, what name you want to use
3. If we can link to you somehow, either through Twitter handle, email, or website.

Anonymous submissions are fine.

Length¶

Posts should be 500 words in length. If your post is much longer (thousands of words), consider whether it could be broken into two connected posts.

Images¶

If you wish to include images, they must be 500 pixels wide or less. You must own the images you're submitting, or they must be available under a Creative Commons license.

The Markdown syntax is a bit limiting when wanting to add style to the image. Therefore, if you want to add style to it (e.g. different alignment than default, add a border, rounded corners, etc.) then just write plain HTML inside your Markdown document.

<img src="{{ get_asset('images/foo.png') }}" width="400" class="my-foo-image" style="any extra styling"/>

Formatting the Blog Post File¶

1. Write your guest post in Markdown and save it in the www/_posts directory.

   • Suggestion #1: Mou.app for mac is created for Markdown - gives you a preview while you write
   • Suggestion #2: dillinger is a web app that provides a live preview when you're writing in Markdown.
   • A cheatsheet for Markdown commands.

2. The very top of the blog post needs the following (including the three dashes before and after the layout/title/tags):

---
layout: post.html
title: "Your title here"
tags: [list, of relevant, tags]
author: Name, or blank/none
author_link: Twitter/Blog/etc or blank/none
---

Process¶

1. Setup your machine by following the Setup your Machine instructions .
2. Save the file in www/_posts.
3. Test your changes locally. Start up mynt as per the instructions below.
4. Make sure that your changes look good, and that there are no errors or formatting issues. If you find problems, stop mynt, make the changes, restart, and check the site again.
5. Commit your changes, and push to your fork of the pyladies/pyladies repository.
6. Create a pull request against the pyladies/pyladies repo.

When you submit a pull request, everyone with commit access for Pyladies will see it. You may also ping the organizers list for more eyes to review.