diff --git a/.build-status-example.png b/.build-status-example.png new file mode 100644 index 0000000..95df272 Binary files /dev/null and b/.build-status-example.png differ diff --git a/README.md b/README.md index 398fac4..fe2eb07 100755 --- a/README.md +++ b/README.md @@ -6,21 +6,39 @@ Website for the Languages, Systems, and Data Lab at UC Santa Cruz. This website is largely based on [the Cornell PL website](https://github.com/cornell-pl/pl.cs.cornell.edu), with special thanks to [Rachit Nigam](https://rachitnigam.com) for technical and moral support! +The LSD website available at and mirrored with some delay at . If you ever notice discrepancies between these, please make an issue. + +In January 2024 the mirror of the website switched from UCSC ITS hosting on AFS to a new AWS host administered by UCSC. We discussed how to mirror and struck an agreement in ticket [INC1792531](https://slughub.ucsc.edu/its?id=ticket&table=incident&sys_id=c418fd681b13f510e8c5eb93604bcb70) that UCSC would run a cron-job on their server to mirror the site. If there's ever a discrepancy betwen those two URLs, we need to ask someone at UCSC to take a look at the cron-job. + ## Making changes to the public site Change the public website in three steps! 1. Change the markdown files and commit your changes to the `main` branch. +1. Push your changes back to the repository. No pull request is necessary. If you prefer to use a pull request, please notify someone in the casl-group mailing list. * Any changes made to the `main` branch will be reflected in the public site after CI/CD runs. -1. Push your changes back to the repository. -1. Check the build status of your commit results in a :heavy_check_mark: build status and not a :x: build status! + * The `public` branch of this repo may be viewed at . +1. Check that your commit results in a :heavy_check_mark: build status and not a :x: build status! ![](.build-status-example.png) * You can find the build status for your commit - on the [commit log](https://github.com/lsd-ucsc/lsd-ucsc.github.io-source/commits/main) + at the top of the [repo page](https://github.com/lsd-ucsc/lsd-ucsc.github.io) + or on the [commit log](https://github.com/lsd-ucsc/lsd-ucsc.github.io-source/commits/main) or find details of the run on the [workflows](https://github.com/lsd-ucsc/lsd-ucsc.github.io-source/actions) page. - * If you're unsure of whether your changes will build, then push to a new branch and make a pull request! + * If you're unsure of whether your changes will build, then push to a new branch and make a pull request (please notify someone in the casl-group mailing list to check your pull request). +1. Your changes will appear at when the build status is a :heavy_check_mark: and will be mirrored at after approximately one hour. You don't need to install hugo because the public site has CI/CD set up. To see how to [build the site locally](#building-the-site-locally), click or scroll to the bottom. +## Content Mangement + +Most of the content is stored under `/content/home`. + +- **about.md**: Content for the About widget on the home page. +- **news.md**: Latest news about the group. To add a new news item, use the + format from the other items. Since the `[[news]]` list is ordered, make sure + that the item is added to the top. +- **faculty.md**, **students.md**, **alumni.md**...: Content for various groups + of members. + ### Adding news items Edit the [news file][news] using one of the formats. @@ -47,18 +65,7 @@ where `` is of the form `2020fa`. Next, edit the file generated in `content/lsd-seminar/.md` and update the link in `config.toml` for `lsd-seminar` to point to the latest webpage. -### Content Mangement - -Most of the content is stored under `/content/home`. - -- **about.md**: Content for the About widget on the home page. -- **news.md**: Latest news about the group. To add a new news item, use the - format from the other items. Since the `[[news]]` list is ordered, make sure - that the item is added to the top. -- **faculty.md**, **students.md**, **alumni.md**...: Content for various groups - of members. - -### Styling +## Styling The styling templates are stored under `layouts/`. Hugo uses a priority-based override method for determining which template to use. By default, it uses @@ -79,7 +86,7 @@ The website is generated by the [Hugo][hugo] website generator and uses the ``` git clone --recurse-submodules git@github.com:lsd-ucsc/lsd-ucsc.github.io-source.git ``` -2. Install [Go][go] (ver >= 0.49.2) and [Hugo][hugo] (ver >= 1.11 && ver <= 49.2). **Note**: The website will not build with newer versions of Hugo. +2. Install [Go][go] (`ver >= 0.49.2`) and [Hugo][hugo] (`ver >= 1.11 && ver <= 49.2`). **Note**: The website will not build with newer versions of Hugo. 3. Run `hugo server -w` to generate and serve the website locally.