From 424611f2973e681127a532a0994aa3d831730b71 Mon Sep 17 00:00:00 2001 From: Philipp Schmitt Date: Tue, 16 Nov 2021 14:24:06 +0100 Subject: [PATCH 1/4] Add HACKING.md Ref: https://github.com/zdharma-continuum/zinit/pull/53 --- HACKING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 HACKING.md diff --git a/HACKING.md b/HACKING.md new file mode 100644 index 000000000..51bce43e5 --- /dev/null +++ b/HACKING.md @@ -0,0 +1,10 @@ +# Updating the gh-pages (zdharma-continuum.github.io) + +1. Check out the [documentation](https://github.com/zdharma-continuum/zinit/tree/documentation) +```shell +git fetch origin documentation +git checkout documentation +``` +2. Do your modifications and push your changes +3. Keep an eye on [the CI logs](https://github.com/zdharma-continuum/zinit/actions/workflows/gh-pages.yaml) +4. If all went well you can head to https://zdharma-continuum.github.io/ to see your changes live. From ce3cd5c616b7b44b68b536d6c22c839b68423c60 Mon Sep 17 00:00:00 2001 From: Philipp Schmitt Date: Tue, 16 Nov 2021 14:36:28 +0100 Subject: [PATCH 2/4] Move HACKING.md to doc/ --- HACKING.md => doc/HACKING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename HACKING.md => doc/HACKING.md (100%) diff --git a/HACKING.md b/doc/HACKING.md similarity index 100% rename from HACKING.md rename to doc/HACKING.md From 633a04d47909da39785d7ec3580809c85b472727 Mon Sep 17 00:00:00 2001 From: Philipp Schmitt Date: Tue, 16 Nov 2021 14:46:24 +0100 Subject: [PATCH 3/4] Link to doc README (#in-case-of-fire) --- doc/HACKING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/HACKING.md b/doc/HACKING.md index 51bce43e5..077cd44e2 100644 --- a/doc/HACKING.md +++ b/doc/HACKING.md @@ -8,3 +8,6 @@ git checkout documentation 2. Do your modifications and push your changes 3. Keep an eye on [the CI logs](https://github.com/zdharma-continuum/zinit/actions/workflows/gh-pages.yaml) 4. If all went well you can head to https://zdharma-continuum.github.io/ to see your changes live. + +**NOTE:** If you really **need** to push directly, without CI please refer to +[the README in the documentation]https://github.com/zdharma-continuum/zinit/blob/documentation/README.md From 2d2adaff5aedf42c320f8b77a5320df116be923c Mon Sep 17 00:00:00 2001 From: Philipp Schmitt Date: Tue, 16 Nov 2021 17:55:22 +0100 Subject: [PATCH 4/4] Clarify that documentation is the name of branch --- doc/HACKING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/HACKING.md b/doc/HACKING.md index 077cd44e2..b8f8ae54e 100644 --- a/doc/HACKING.md +++ b/doc/HACKING.md @@ -1,6 +1,6 @@ # Updating the gh-pages (zdharma-continuum.github.io) -1. Check out the [documentation](https://github.com/zdharma-continuum/zinit/tree/documentation) +1. Check out the [documentation branch](https://github.com/zdharma-continuum/zinit/tree/documentation) ```shell git fetch origin documentation git checkout documentation