Merge pull request creativecommons#217 from creativecommons/readme-updates

Minor README updates to improve clarity and readability

Author: TimidRobot

README.md

@@ -2,20 +2,22 @@
 
 Source for `creativecommons.github.io`
 
-**:warning: DO *NOT* MAKE CHANGES TO THE [creativecommons.github.io][ccghiorepo]
-REPO DIRECTLY**.
 
-[ccghiorepo]:https://github.com/creativecommons/creativecommons.github.io
+## Overview
 
+> **:warning: DO *NOT* MAKE CHANGES TO THE
+> [creativecommons/creativecommons.github.io][ccghiorepo] REPO DIRECTLY**.
 
-## Overview
+[ccghiorepo]:https://github.com/creativecommons/creativecommons.github.io
 
 This site is built using [Lektor][lektor]. All changes to
-[https://creativecommons.github.io][ccgithubio] must be made **here** and
-deployed via lektor (see [Deployment](#deployment), below).
+[opensource.creativecommons.org][ccopensource]
+([creativecommons.github.io][ccgithubio]) must be made **here** and deployed
+via lektor (see [Deployment](#deployment), below).
 
-[lektor]:https://www.getlektor.com/
-[ccgithubio]:https://creativecommons.github.io
+[lektor]: https://www.getlektor.com/
+[ccgithubio]: https://creativecommons.github.io/
+[ccopensource]: https://opensource.creativecommons.org/
 
 
 ## Installation
@@ -42,34 +44,43 @@ else fails, try removing the virtual environment and reinstalling:
 
 ## Development
 
-1. Run `pipenv shell` to spawn a shell with the virtualenv activated.
-2. Run `lektor server -f webpack` to start the Lektor development server. You will be able
-   to see the website at [`http://localhost:5000/`][lektorlocal]. The Lektor
-   server will rebuild the site every time you change any content.
+- 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/`][local5000].
+  - The Lektor server will rebuild the site every time you change any content.
 
-[lektorlocal]:http://localhost:5000/
+[local5000]:http://localhost:5000/
 
 
 ## 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. Travis CI builds and deploys the site whenever it detects new commits on the `master` branch.
+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`][lektorbuild].
+
+[lektorbuild]: .github/workflows/lektor-build-deploy.yml
 
 
 ### Manual Deployment
 
-**For reference only, you should not need to not do this.**
+> :warning: **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.github.io][ccghiorepo] repository). That's it, it's live
-on production!
+the [creativecommons/creativecommons.github.io][ccghiorepo] 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.
+  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][lektorcontent]. This is probably what you'll be
   modifying most often.
@@ -79,8 +90,9 @@ Here's how the code is structured in the top level of the repository:
 - **`templates`**: This is where the [Jinja2][jinja2] templates that render
   content are stored. See the [Lektor template documentation][lektortemplate]
   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 assets folder       during lektor build process.
+- **`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 assets folder during lektor build process.
 
 [lektorcontent]:https://www.getlektor.com/docs/content/
 [lektormodels]:(https://www.getlektor.com/docs/models/