Skip to content

update README #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 20, 2025
Merged

update README #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75936fb
update README
carlosmalt Jan 20, 2025
a62ac05
update links in README
carlosmalt Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +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
- [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.
- 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.