Skip to content

Latest commit

 

History

History
241 lines (161 loc) · 9.65 KB

README.md

File metadata and controls

241 lines (161 loc) · 9.65 KB
Raw

creativecommons.github.io-source

Source for creativecommons.github.io

Overview

⚠️ DO NOT MAKE CHANGES TO THE creativecommons/creativecommons.github.io REPO DIRECTLY.

This site is built using Lektor. All changes to opensource.creativecommons.org (creativecommons.github.io) must be made here and deployed via lektor (see Deployment, below).

Code of Conduct

CODE_OF_CONDUCT.md:

The Creative Commons team is committed to fostering a welcoming community. This project and all other Creative Commons open source projects are governed by our Code of Conduct. Please report unacceptable behavior to [email protected] per our reporting guidelines.

Contributing

Installation

Pre-Requisites

Make sure you have:

To install these, execute the following commands:

For macOS:

  1. brew install pipenv
  2. brew install node

For GNU/Linux:

  1. curl https://raw.githubusercontent.com/kennethreitz/pipenv/master/get-pipenv.py | python
  2. sudo apt update
  3. Install Node.js
  4. sudo apt install npm

Installing Project Requirements

  1. Clone this repository.
  2. Open your command line interface and cd to the repository root directory.
  3. Run pipenv install to create a Python virtual environment and install the requirements for this project.

pipenv Troubleshooting

pipenv doesn't always provide the best error messages (Provide better error message if the project’s virtual environment is broken). If all else fails, try removing the virtual environment and reinstalling:

  1. pipenv --rm
  2. pipenv install

Development

  • Run pipenv run lektor server -f webpack to start the Lektor development server.
  • You will be able to see the website at http://localhost:5000/.
    • The Lektor server will rebuild the site every time you change any content.

Troubleshooting Possible Errors

  • Should you get series of type errors that looks something like npm ERR! typeerror Error: Missing required argument #1, after running pipenv run lektor server -f webpack, this is most likely due to running an older version of Node.js.

    As stated earlier in the prerequisites, you should be running Node.js version 12+. Follow this tutorial to upgrade your node version (for GNU/Unix systems).

  • Should you get an OSError: [Errno 28] inotify watch limit reached after running any command, this means that your system file watcher is running out of alloted handles, usually because the workspace is large and contains many files.

    The solution is to run: sudo sysctl fs.inotify.max_user_watches=524288

    This increases your inotify watch limit (for the session) to 524288, which is the maximum value and is also enough to allow the setup go through. You can learn more about file watchers from this blog post or from the VS Code documentation.

Deployment

We have continuous deployment set up. To deploy, push your code to the master branch (or make a pull request against the master branch. GitHub Actions builds and deploys the site whenever it detects new commits on the master branch.

The GitHub Actions configuration is located at .github/workflows/lektor-build-deploy.yml.

Manual Deployment

⚠️ For reference only, you should not need to not do this.

When you are ready to deploy a new version of the site, run lektor deploy (assuming you have your GitHub SSH key already set up and you have access to the creativecommons/creativecommons.github.io repository). That's it, it's live on production!

Project Structure

Here's how the code is structured in the top level of the repository:

  • assets: This directory contains the JavaScript and CSS files for the project built via webpack. Most of the JavaScript and CSS is third-party code and loaded via CDN so this is pretty empty.
  • content: The content of the site lives here. Here's an explanation of how content works in Lektor. This is probably what you'll be modifying most often.
  • models: All content in Lektor is associated with data models to define their schema. Currently, we only use the default page model that ships with Lektor.
  • templates: This is where the Jinja2 templates that render content are stored. See the Lektor template documentation for more information.
  • webpack: This is where all the webpack config files as well as Sass and JavaScript files for the project resides. The JavaScript and Sass files are compiled and saved in the assets folder during lektor build process.

Lektor Plugins

Redirects

  • /cc-vocabulary/ to https://cc-vocabulary.netlify.com/
    • Added so that the opensource.creativecommons.org/cc-vocabulary/ will continue to work with that project moving to utilize Netlify.
  • /cc-vue-vocabulary to https://cc-vue-vocabulary.netlify.com/
    • Added so that the opensource.creativecommons.org/cc-vue-vocabulary/ will continue to work with that project moving to utilize Netlify.
  • /cc-fonts to https://cc-fonts.netlify.com/
    • Added so that the opensource.creativecommons.org/cc-fonts/ will continue to work with that project moving to utilize Netlify.

License

Code

Content

CC BY 4.0 license button

All the content within this repository is licensed under a Creative Commons Attribution 4.0 International License unless otherwise specified.

Font Awesome

This repository contains PNG icons that were converted from Font Awesome SVGs:

Font Awesome Free is free, open source, and GPL friendly. You can use it for commercial projects, open source projects, or really almost whatever you want. (Full Font Awesome Free license: https://fontawesome.com/license/free)

Icons: CC BY 4.0 License (https://creativecommons.org/licenses/by/4.0/) In the Font Awesome Free download, the CC BY 4.0 license applies to all icons packaged as SVG and JS file types.