You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: www/README.md
+2-16Lines changed: 2 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ git commit -m '<some message>'
44
44
gh pr create # if you use the GitHub CLI
45
45
```
46
46
47
-
When reviewed and mereged, you are ready to publish documentation to the live site:
47
+
When reviewed and merged, you are ready to publish documentation to the live site:
48
48
```bash
49
49
# From repository root INSIDE your Docker instance
50
50
make docs-publish
@@ -58,19 +58,6 @@ Push to live site: cd www/docs_site/; git add -A; git commit -m 'update to <comm
58
58
59
59
The commit hash in the last line should be the hash of your commit in the skip repository.
60
60
61
-
This will suggest running:
62
-
```bash
63
-
# Test locally
64
-
make docs-serve
65
-
66
-
# Push to live site
67
-
cd www/docs_site/
68
-
git add -A
69
-
git commit -m 'update to <hash_of_your_commit>'
70
-
git push
71
-
cd -
72
-
```
73
-
74
61
> **Note**: If `make docs-publish` is run from a commit that is not (an ancestor of) `main`, the docs_site commit messages will contain incorrect commit hashes.
75
62
76
63
## Documentation Structure
@@ -94,9 +81,8 @@ git clean -Xdn # -n for a dry-run and double-check what's to be cleaned out
94
81
git clean -Xdf # the actual cleaning
95
82
```
96
83
97
-
### What if the hash is not in the commit message suggested along the process ?
84
+
### What if the hash in the suggested commit message is not the hash of your commit?
98
85
You can get it from the skip repository:
99
86
```bash
100
87
git rev-parse --short HEAD # supposingly it is the last commit of the branch
0 commit comments