Skip to content

Commit ef9ea01

Browse files
committed
Josh's comments
1 parent ba72f18 commit ef9ea01

File tree

1 file changed

+2
-16
lines changed

1 file changed

+2
-16
lines changed

www/README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ git commit -m '<some message>'
4444
gh pr create # if you use the GitHub CLI
4545
```
4646

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:
4848
```bash
4949
# From repository root INSIDE your Docker instance
5050
make docs-publish
@@ -58,19 +58,6 @@ Push to live site: cd www/docs_site/; git add -A; git commit -m 'update to <comm
5858

5959
The commit hash in the last line should be the hash of your commit in the skip repository.
6060

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-
7461
> **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.
7562
7663
## Documentation Structure
@@ -94,9 +81,8 @@ git clean -Xdn # -n for a dry-run and double-check what's to be cleaned out
9481
git clean -Xdf # the actual cleaning
9582
```
9683

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?
9885
You can get it from the skip repository:
9986
```bash
10087
git rev-parse --short HEAD # supposingly it is the last commit of the branch
10188
```
102-

0 commit comments

Comments
 (0)