8000 Update README by rustagir · Pull Request #41 · mongodb/docs-java-other · GitHub
[go: up one dir, main page]

Skip to content

Update README #41

New issue
8000

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 7, 2024
Merged

Update README #41

merged 3 commits into from
May 7, 2024

Conversation

rustagir
Copy link
Collaborator
@rustagir rustagir commented May 6, 2024

No description provided.

@rustagir rustagir requested a review from norareidy May 6, 2024 15:20
Copy link
Collaborator
@norareidy norareidy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just one comment from me!


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

```sh
git checkout r4.4.0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I: there was one extra step I had to take before copying the build/docs folder! Since you're not running the publish-docs script from the old build instructions, you need to create the <version>/apidocs directory yourself before copying the docs files.

I think we could add a step that instructs the user to navigate to docs-java-other/mongo-java-driver and run mkdir -p <version>/apidocs. Then, they can run cp -a ../mongo-java-driver/build/docs ./mongo-java-driver/<version>/apidocs

@rustagir rustagir requested a review from norareidy May 7, 2024 15:15
Copy link
Collaborator
@norareidy norareidy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@rustagir rustagir merged commit f00eca5 into mongodb:main May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0