8000 Update README.md · mongodb/docs-java-other@5e691c5 · GitHub
[go: up one dir, main page]

Skip to content

Commit 5e691c5

Browse files
author
Chris Cho
authored
Update README.md
1 parent 0d12517 commit 5e691c5

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ after checking out the correct tag. Ensure you installed the Java version specif
5656

5757
:warning: **Use the GitHub "release" that correspond to the version of the driver rather than a branch**
5858

59-
For example, to build the API docs for the 4.4 release of driver:
59+
For example, to build the API docs for the 4.4 release of driver run the following commands:
6060

6161
```sh
6262
git checkout r4.4.0
6363
./gradlew clean docs
6464
```
6565

6666
Then copy the `build/docs` folder into the `apidocs` directory. For example,
67-
if the `mongo-java-driver` repo is on a sibling level with this repo:
67+
if the `mongo-java-driver` repo is on a sibling level with this repo, run the following command:
6868

6969
```sh
7070
cp -a ../mongo-java-driver/build/docs ./mongo-java-driver/<version>/apidocs
@@ -89,4 +89,4 @@ git rebase -i --root
8989
git push origin gh-pages -f
9090
```
9191

92-
:warning: **Make sure you are starting from the latest gh-pages branch commit in the mongo-java-driver submodule. This may not be set if you did not run the publish-docs script from docs-java-other on your local machine (e.g. if the task only involved generating reference docs on Docker and copying them over).
92+
:warning: Make sure you are starting from the latest gh-pages branch commit in the mongo-java-driver submodule. This may not be set if you did not run the publish-docs script from docs-java-other on your local machine (e.g. if the task only involved generating reference docs on Docker and copying them over).

0 commit comments

Comments
 (0)
0