netlify-website-template

Example of PyLadies Website theme powered by Netlify with a standard pull request template. You can preview the template here.

What is Netlify?

Netlify is a simple tool to use for continuous integration and continuous development (CI/CD). It allows you to specify custom build commands as well as run checks in your pull requests. You can additionally get a deploy preview of your website capturing the changes generated in a pull request on a Netlify hosted url. Here's an example pull request to see the checks and deploy.

Setting up you website with Netlify

1. Fork the repo.
2. This repo has gh-pages set as the default branch.
3. Register for a Netlify account. Open source teams qualify for free OSS accounts, use your pyladies chapter email address when creating your account. You'll need to host a Netlify badge on your website which is already included in the emplate. Please note that any overages will be additionally charged.
4. Setup your site with these directions. As this is a simple html and css website there is no need for custom build steps.
5. If you have requested a custom domain you can configure that within your Netlify site.

Template Information

• Main file you'll update is index.html where you can add organizer information, your own chapter branding, contact links for your chapter, and replace the skyline image.
• You'll want to place organizer photos can be placed in the images/bios directory and update the images/skyline.jpg with your own desired skyline image.
• If you rename the skyline image modify the style.css to point it to the image, look for the .skyline css rule.
• Add your custom @pyladies/chapter-organizer team that is created when you add your website to the PyLadies Chapter Website repo e.g. @pyladies/chicago

Local Development

If you'd like to see your changes locally you can use Python3 to serve up the content by:

$ cd /root-of-forked-directory
$ python -m http.server # Defaults to port 8000, you can change by providing an additional integer for the desired port

Option: Hosting your website on GitHub pages

GitHub provides a free hosted page for each GitHub user. You can setup your page either via:

1. Using and creating a repo github_username.github.io.
2. Using gh-pages branch, which is the default branch on this template.

You can look at your repository > settings > GitHub Pages for more information on generating the CNAME file if you have a custom domain.

Questions?

Ask for help in the PyLadies Slack in the #project-tech-infra channel.

Acknowledgements

PyLadies NYC created this theme initially, thank you!