We'd love to accept your patches and contributions to this project.
If you are contributing AIP content (rather than code) and want to be able to view it in your browser, the easiest way to do so is to run the provided development server.
We use GitHub Pages to make this documentation available, and a specific site generator to build the site.
If you have Docker installed, clone this repository and run the
file at the root of the repository. This script does two things:
- It builds the provided Docker image (unless you already have it) and tags it
- It runs the
The development server uses port 4000; point your web browser to
http://localhost:4000, and you should see the site.
Note: After building the Docker image for the first time, you may
experience issues if Python dependencies change underneath you. If this
happens, remove your Docker image (
docker rmi aip-site) and run
Any arguments provided to
docker run) are forwarded (however,
the current site generator does not honor any; this may change in the future).
The development server recognizes when files change (including static files) and local changes will be automatically reflected in your browser upon reload.
It is possible to run the development server locally also. The general gist of how to do so correctly is:
- Install Python 3.8 if you do not already have it (direct install is fine, but pyenv is probably the best way if you have other Python projects).
- Create a Python 3.8 venv. Once it is created, activate it in your shell
pip install git+https://github.com/aip-dev/site-generator.git
Contributor License Agreement
Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you have already submitted one (even if it was for a different project), you probably do not need to do it again.
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.