docs: make update command and clarify update steps/potential danger

Jacky Zhao

2022-04-05 a7abc6ab96002d103e5e349f345d4108550256f5

docs: make update command and clarify update steps/potential danger

 Makefile

@@ -8,6 +8,11 @@
    git fetch upstream
    git log --oneline --decorate --graph ..upstream/hugo
    git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data 

update-force: ## Forcefully pull all changes and don't ask to patch 
    @git remote show upstream || (echo "remote 'upstream' not present, setting 'upstream'" && git remote add upstream https://github.com/jackyzha0/quartz.git)
    git fetch upstream
    git checkout upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data

serve: ## Serve Quartz locally
    hugo-obsidian -input=content -output=assets/indices -index -root=. && hugo server --enableGitInfo

 content/notes/setup.md

@@ -31,11 +31,21 @@
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).

## Updating
Haven't updated Quartz in a while and want all the cool new optimizations?
Haven't updated Quartz in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press `q` to acknowledge this. Then, it will show you each change in turn and press `y` to accept the patch or `n` to reject it. Usually you should press `y` for most of these unless it conflicts with existing changes you've made! 

```shell
make update

# or, if you don't want the interactive parts and just want the update
make update-force
```

Or, manually checkout the changes yourself.

> ⚠️ **WARNING** ⚠️
>
> if you customized `assets/styles/custom.scss`, the files in `data/`, or anything inside `layouts/`, your customization may be overwritten!
> If you customized the files in `data/`, or anything inside `layouts/`, your customization may be overwritten!
> Make sure you have a copy of these changes if you don't want to lose them.


```shell
@@ -44,5 +54,5 @@

# index and fetch changes
git fetch upstream
git checkout upstream/hugo -- layouts .github Makefile assets config.toml data static
git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data 
```