From 75936fb1fb1593c0080be966d50300bd1f2004ee Mon Sep 17 00:00:00 2001 From: Carlos Maltzahn Date: Sun, 19 Jan 2025 18:20:49 -0800 Subject: [PATCH 1/2] update README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0de7bc2..8bd7308 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ Everything that is pushed or merged with the `main` branch will automatically tr 1. **Using a local git repository (recommended):** - Clone the repository, - Perform edits -- I highly recommend using Visual Studio Code for editing and common git commands. It does a great job showing all files in the repository and their git status. Make sure to create a repository in a _local_ directory that is not backed by Google Drive, iCloud, or any other file sharing service. Bad things tend to happen if you do, and - - [Install hugo](https://wowchemy.com/docs/getting-started/install-hugo-extended/#prerequisites) (skip "Download a Template") and [view your site](https://wowchemy.com/docs/getting-started/install-hugo-extended/#view-your-site) locally using `hugo server` (it quickly rebuilds the local view whenever you save a change). - - Create a pull request against the `main` branch of the origin `acm-rep/2025` repository. + - [Install hugo](https://docs.hugoblox.com/getting-started/install-hugo/) (skip "Download a Template") and [view your site](https://docs.hugoblox.com/getting-started/install-hugo/#view-your-site) locally using `hugo server -D` (it quickly rebuilds the local view whenever you save a change). + - Create a pull request against the `main` branch of the origin `acm-rep/2025` repository. This will create a Netlify preview within the pull request. Any additional pushes to the pull request's branch will update the preview. 2. **Using the github website:** fork the repository, perform the edits there and create a pull request against this repository. Unfortunately, I have not figured out how to get the web page render correctly in a forked repository. + +3. **Using VS Code for the Web:** By replacing `.com` in the github repository's web address with `.dev`, one can use [Visual Studio Code for the Web](https://code.visualstudio.com/docs/editor/vscode-web). This allows creating branches, committing updates, creating pull requests, and merging them without any local environment. From a62ac05850b6276ab308c7940642d017fca64f79 Mon Sep 17 00:00:00 2001 From: Carlos Maltzahn Date: Sun, 19 Jan 2025 18:27:41 -0800 Subject: [PATCH 2/2] update links in README --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8bd7308..acdcbb1 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,17 @@ Everything that is pushed or merged with the `main` branch will automatically tr ## Editing the website -**For small edits** just edit the relevant markdown file directly on github. It is safer to create a pull request than to commit directly to main since a pull request will determine conflicts without interrupting other progress. +**For small edits** just edit the relevant markdown file directly on github (see possibility 3 below). It is safer to create a pull request than to commit directly to main since a pull request will determine conflicts without interrupting other progress. -**For larger edits** there are two possibilities: +**For larger edits** there are three possibilities: 1. **Using a local git repository (recommended):** - Clone the repository, - - Perform edits -- I highly recommend using Visual Studio Code for editing and common git commands. It does a great job showing all files in the repository and their git status. Make sure to create a repository in a _local_ directory that is not backed by Google Drive, iCloud, or any other file sharing service. Bad things tend to happen if you do, and + - Perform edits -- I highly recommend using [Visual Studio Code](https://code.visualstudio.com/) for editing and common git commands. It does a great job showing all files in the repository and their git status. Make sure to create a repository in a _local_ directory that is not backed by Google Drive, iCloud, or any other file sharing service. Bad things tend to happen if you do, and - [Install hugo](https://docs.hugoblox.com/getting-started/install-hugo/) (skip "Download a Template") and [view your site](https://docs.hugoblox.com/getting-started/install-hugo/#view-your-site) locally using `hugo server -D` (it quickly rebuilds the local view whenever you save a change). - Create a pull request against the `main` branch of the origin `acm-rep/2025` repository. This will create a Netlify preview within the pull request. Any additional pushes to the pull request's branch will update the preview. -2. **Using the github website:** fork the repository, perform the edits there and create a pull request against this repository. Unfortunately, I have not figured out how to get the web page render correctly in a forked repository. +2. **Using VS Code for the Web:** By replacing `.com` in the github repository's web address with `.dev`, one can use [Visual Studio Code for the Web](https://code.visualstudio.com/docs/editor/vscode-web). This allows creating branches, committing updates, creating pull requests, and merging them without any local environment. + +3. **Using the github website:** fork the repository, perform the edits there and create a pull request against this repository. Unfortunately, I have not figured out how to get the web page render correctly in a forked repository. + -3. **Using VS Code for the Web:** By replacing `.com` in the github repository's web address with `.dev`, one can use [Visual Studio Code for the Web](https://code.visualstudio.com/docs/editor/vscode-web). This allows creating branches, committing updates, creating pull requests, and merging them without any local environment.