Skip to content

Commit 45a3f2d

Browse files
committed
minor content and formatting updates
1 parent 311f442 commit 45a3f2d

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

README.md

+27-15
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22

33
Source for `creativecommons.github.io`
44

5+
6+
## Overview
7+
58
**:warning: DO *NOT* MAKE CHANGES TO THE [creativecommons.github.io][ccghiorepo]
69
REPO DIRECTLY**.
710

811
[ccghiorepo]:https://github.com/creativecommons/creativecommons.github.io
912

10-
11-
## Overview
12-
1313
This site is built using [Lektor][lektor]. All changes to
14-
[https://creativecommons.github.io][ccgithubio] must be made **here** and
15-
deployed via lektor (see [Deployment](#deployment), below).
14+
[opensource.creativecommons.org][ccopensource]
15+
([creativecommons.github.io][ccgithubio]) must be made **here** and deployed
16+
via lektor (see [Deployment](#deployment), below).
1617

17-
[lektor]:https://www.getlektor.com/
18-
[ccgithubio]:https://creativecommons.github.io
18+
[lektor]: https://www.getlektor.com/
19+
[ccgithubio]: https://creativecommons.github.io/
20+
[ccopensource]: https://opensource.creativecommons.org/
1921

2022

2123
## Installation
@@ -42,17 +44,25 @@ else fails, try removing the virtual environment and reinstalling:
4244

4345
## Development
4446

45-
1. Run `pipenv shell` to spawn a shell with the virtualenv activated.
46-
2. Run `lektor server -f webpack` to start the Lektor development server. You will be able
47-
to see the website at [`http://localhost:5000/`][lektorlocal]. The Lektor
48-
server will rebuild the site every time you change any content.
47+
Run `pipenv run lektor server -f webpack` to start the Lektor development
48+
server. You will be able to see the website at
49+
[`http://localhost:5000/`][lektorlocal]. The Lektor server will rebuild the
50+
site every time you change any content.
4951

5052
[lektorlocal]:http://localhost:5000/
5153

5254

5355
## Deployment
5456

55-
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.
57+
We have continuous deployment set up. To deploy, push your code to the `master`
58+
branch (or make a pull request against the `master` branch. GitHub Actions
59+
builds and deploys the site whenever it detects new commits on the `master`
60+
branch.
61+
62+
The GitHub Actions configuration is located at
63+
[`.github/workflows/lektor-build-deploy.yml`][lektorbuild].
64+
65+
[lektorbuild]: .github/workflows/lektor-build-deploy.yml
5666

5767

5868
### Manual Deployment
@@ -69,7 +79,8 @@ on production!
6979

7080
Here's how the code is structured in the top level of the repository:
7181
- **`assets`**: This directory contains the JavaScript and CSS files for the
72-
project built via webpack. Most of the JavaScript and CSS is third-party code and loaded via CDN so this is pretty empty.
82+
project built via webpack. Most of the JavaScript and CSS is third-party code
83+
and loaded via CDN so this is pretty empty.
7384
- **`content`**: The content of the site lives here. [Here's an explanation of
7485
how content works in Lektor][lektorcontent]. This is probably what you'll be
7586
modifying most often.
@@ -79,8 +90,9 @@ Here's how the code is structured in the top level of the repository:
7990
- **`templates`**: This is where the [Jinja2][jinja2] templates that render
8091
content are stored. See the [Lektor template documentation][lektortemplate]
8192
for more information.
82-
- **`webpack`**: This is where all the webpack config files as well as Sass and
83-
JavaScript files for the project resides. The JavaScript and Sass files are compiled and saved in assets folder during lektor build process.
93+
- **`webpack`**: This is where all the webpack config files as well as Sass and
94+
JavaScript files for the project resides. The JavaScript and Sass files are
95+
compiled and saved in assets folder during lektor build process.
8496

8597
[lektorcontent]:https://www.getlektor.com/docs/content/
8698
[lektormodels]:(https://www.getlektor.com/docs/models/

0 commit comments

Comments
 (0)