VPIFG

Source files and content for https://vpifg.com

Contribute

There are three primary ways to contribute:

1. Edit directly on the website (Easiest).
2. Edit using Gitpod (Easy and you get to see a local preview).
3. Local checkout.

In all cases, you will have to:

1. Follow the Contribution Guidelines
2. Create a Pull-Request
3. Sign the CLA*
4. Respond to any feedback, and wait for merge.

Once the PR is merged, it will immediately be live.

Edit on Website

See Editing files in your repository .

Example: Edit this file

Edit in Gitpod

This is the recommended workflow

Gitpod will bootstrap a cloud dev environment for you. It is temporary, so push your changes regularly, but everything will be setup out of the box. You can even preview your ideas live.

Local Checkout

Pre-Requisites

1. Git must be installed
2. Python 3.8.9 or greater

Install

$ git clone https://github.com/JakeGWater/vpifg.com
$ cd vpifg.com
$ pip3 install -r requirements.txt

Develop

npm start

You do not need npm, it is for convenience only. Check out the package.json file for the direct python commands to run.

View your site at http://localhost:3000/

Pull Requests

Submitted Pull Requests will be deployed to https://vpifg.com/PREVIEW/$NUMBER where $NUMBER is the number of your pull request.

Architecture

1. We use Sphinx to build a static html site using, docutils and reStructuredText.
2. We use a modified Pydata Sphinx Theme.
3. Pull-requests are tested using a GitHub Test Action.
4. CLA Assistant handles the CLAs.
5. On merging to main we use a GitHub Build Action to deploy a gh-pages branch.
6. GitHub Pages hosts the static site.
7. Cloudflare provides a CDN.

The above architecture currently has zero reocurring costs, aside from the domain name.

License

All content in source is licensed according to source/LICENSE.md, unless otherwise specified in source/about/licenses.rst or as noted within the file.

All content outside of source is licensed under its original licenses, or licensed as MIT as a fallback.

CLA

See https://vpifg.com/cla