|
1 | 1 | # README |
2 | 2 |
|
3 | | -N.b. see [./al-folio.README.md](./al-folio.README.md) for the original forked README from the Jekyll Al-Folio theme. |
| 3 | +(by Alex, Cesare) |
4 | 4 |
|
| 5 | +**NB:** see [./al-folio.README.md](./al-folio.README.md) for the original forked README from the Jekyll Al-Folio theme. |
5 | 6 |
|
6 | 7 | ## Setting up your local |
7 | | -I highly suggest you use docker-compose. See [./al-folio.README.md](./al-folio.README.md) for further instructions. You should end up in a scenario where booting your local requires only that you issue the command |
8 | 8 |
|
9 | | -``` |
| 9 | +We highly suggest you use docker-compose. See [./al-folio.README.md](./al-folio.README.md) for further instructions. You should end up in a scenario where booting your local requires only that you issue the command |
| 10 | + |
| 11 | +```shell |
10 | 12 | docker-compose up |
11 | 13 | ``` |
12 | 14 |
|
13 | | -Your local will be at http://0.0.0.0:8080; most people (like myself) like to rename this address in the local hosts file. That is, add the following to `/etc/hosts/` on Ubuntu, `/private/etc/hosts/` on mac, or `C:\Windows\System32\drivers\etc\hosts` on Windows. |
| 15 | +Your local will be at http://0.0.0.0:8080; most people (like Alex) like to rename this address in the local hosts file. That is, add the following to `/etc/hosts/` on Ubuntu, `/private/etc/hosts/` on mac, or `C:\Windows\System32\drivers\etc\hosts` on Windows. |
14 | 16 |
|
15 | 17 | ``` |
16 | 18 | 0.0.0.0 clc |
17 | 19 | ``` |
18 | 20 |
|
19 | 21 | This makes http://clc:8080 access http://0.0.0.0:8080. |
20 | 22 |
|
21 | | - |
22 | 23 | ## How to Jekyll |
| 24 | + |
23 | 25 | [Read the docs](https://jekyllrb.com/docs/). This [step by step guide](https://jekyllrb.com/docs/step-by-step/01-setup/) has most of what you need to know; read, in particular, the pages on layouts, includes, and collections. |
24 | 26 |
|
25 | 27 | ## Contribution & to-do's |
26 | 28 |
|
27 | 29 | ### Editing the homepage |
28 | 30 |
|
29 | | -Just edit [_pages/about.md](_pages/about.md). **I am not a CSS or SASS expert.** I leave the styling of the homepage up to whomever would like to change it. |
| 31 | +Just edit [_pages/about.md](_pages/about.md). **We are not CSS or SASS experts.** We leave the styling of the homepage up to whomever would like to change it. |
30 | 32 |
|
31 | 33 | ### Editing the styling |
32 | 34 |
|
33 | | -Garrett mentioned this resource from UI on [how to style like a UI site](https://uids.brand.uiowa.edu/?path=/docs/components-alert--docs). If anyone wants to tackle that, good luck! |
| 35 | +Garrett mentioned this resource from UI on [how to style like a UI site](https://uids.brand.uiowa.edu/?path=/docs/components-alert--docs). If anyone wants to tackle that, good luck! |
34 | 36 |
|
35 | 37 | ### Editing members |
36 | | -Go to [_members](./_members). |
37 | 38 |
|
38 | | -- If you are a graduate student, copy [alex.md](./_members/alex.md) to `yourname.md`. |
| 39 | +Go to [_members](./_members). |
| 40 | + |
| 41 | +- If you are a graduate student, copy [alex.md](./_members/alex.md) to `yourname.md`. |
39 | 42 | - If you are a professor, copy [garrett.md](./_members/garrett.md) to `yourname.md`. |
40 | | -- If you are a post-doc / research scientist, [andrew.md](./_members/andrew.md) to `yourname.md`. |
| 43 | +- If you are a research scientist, [daniel.md](./_members/daniel.md) to `yourname.md`. |
| 44 | +- If you are a post-doc, [andrew.md](./_members/andrew.md) to `yourname.md`. |
41 | 45 |
|
42 | 46 | **Do not edit the _role_ field**. Otherwise, change the metadata appropriately. **Add a picture of yourself to [./assets/img/](./assets/img/); make sure the name of the photo you add agrees with the name in your markdown file. |
43 | 47 |
|
44 | | - |
45 | | -**I expect you to add your own member entry. -@ahubers** |
46 | | - |
47 | 48 | ### Editing projects and linked repositories |
48 | 49 |
|
| 50 | +[Currently inactive] |
49 | 51 | Edit [_pages/projects.md](./_pages/projects.md) to change the copy on the **projects** pages. Edit the `artifacts` entry in [_data/repositories.yml](_data/repositories.yml) to change the "popular repositories" entries on the projects page. |
50 | 52 |
|
51 | 53 | ### Editing recent publications |
52 | 54 |
|
53 | | -Add an entry to [_bibliography/papers.bib](_bibliography/papers.bib). N.b. If you want to add a photo with your publication, change the "preview" entry in [_bibliography/papers.bib](_bibliography/papers.bib) to the name of an image located at [assets/img](./assets/img). |
| 55 | +Add an entry to [_bibliography/papers.bib](_bibliography/papers.bib). |
| 56 | + |
| 57 | +**NB:** If you want to add a photo with your publication, change the "preview" entry in [_bibliography/papers.bib](_bibliography/papers.bib) to the name of an image located at [assets/img](./assets/img). |
| 58 | + |
| 59 | +### Editing news |
54 | 60 |
|
55 | | -### Editing news / announcements |
| 61 | +Add a item to as a single markdown file to [_news/](./_news). See the files already in their for the expected format. |
56 | 62 |
|
57 | | -I don't have this set up quite yet. Please advise on if we want it, for what we would use it (if so), and how it should appear on the site. |
| 63 | +### Editing announcements |
58 | 64 |
|
| 65 | +We don't have this set up quite yet. Please advise on if we want it, for what we would use it (if so), and how it should appear on the site. |
0 commit comments