Send Your Changes for Review
After you complete your changes and fixed any warnings and errors reported by Antora, it’s time to commit and push your working branch to your remote repository.
Commit, Rebase, and Push
-
Add the new and changed files.
$ git add file-path-and-name
-
Commit your changes.
$ git commit -m "fix magic bucket example"
-
Fetch any upstream base branch changes.
$ git fetch upstream name-of-base-branch
-
If the upstream base branch has changed, rebase your working branch against it.
$ git rebase upstream/name-of-base-branch
-
Push your working branch to your remote fork on GitHub.
$ git push origin DOC-$$$$
Submit a Pull Request
After you push your working branch to your remote repository on GitHub, you can submit a pull request to the upstream repository for review.
-
Go to your repository on GitHub, and click Compare & pull request.
-
On the Open a Pull Request screen, update the PR title if it needs clarification, and then click Create Pull Request.
Your pull request will be reviewed by a member of the Documentation team. Feedback and suggestions for improvements to the pull request are a standard part of the process, to ensure consistency across the documentation. Response will normally be within a couple of working days, but can sometimes take longer — please bear with us, we really do appreciate contributions from the community.
Incorporate Feedback from a Review
To incorporate feedback from a review of an existing pull request, use GitHub’s Applying Suggested Changes instruction page.
Next Step
Learn how AsciiDoc is used for Couchbase documentation.