Skip to content

Commit

Permalink
adding doc to main
Browse files Browse the repository at this point in the history
Signed-off-by: chawinphat <chawinphat@berkeley.edu>
  • Loading branch information
chawinphat committed Dec 27, 2023
1 parent a66ee2d commit 05edc92
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ With this workflow, OpenSearch-Build documentation can be organized within the W
### Submit a change to the Wiki
To submit a documentation update, update the markdown files within the `docs` folder accordingly, or create new files using the naming convention specified by the [workflow](https://github.com/Andrew-Chen-Wang/github-wiki-action) .

To test your changes, you can create a fork of Opensearch-Build. Commiting and pushing changes to the docs folder of your fork will run the workflow and update the fork's Wiki page.
To test your changes, you can create a fork of OpenSearch-Build. Commiting and pushing changes to the docs folder of your fork's main branch will run the workflow and update the fork's Wiki page.

Finally, create a pull request containg the changes. Adding a link to your fork's Wiki page within the pull request will help reviewers understand your changes.
Finally, create a pull request containing the changes. Adding a link to your fork's Wiki page within the pull request will help reviewers understand your changes.

0 comments on commit 05edc92

Please sign in to comment.