added documentation

Signed-off-by: chawinphat <chawinphat@berkeley.edu>
chawinphat · Dec 26, 2023 · 550901d · 550901d
1 parent 5b3f600
commit 550901d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -4,11 +4,23 @@ This repository's [Github Wiki](https://github.com/opensearch-project/opensearch
 With this workflow, OpenSearch-Build documentation can be organized within the Wiki tab, while maintaining the ability for contributors to submit reviewable documentation updates in the form of pull requests.
 
 
+### Submit a change to the Wiki### How is the Wiki Updated?
+This repository's [Github Wiki](https://github.com/opensearch-project/opensearch-build/wiki) utilizes the [github-wiki-action](https://github.com/Andrew-Chen-Wang/github-wiki-action) workflow. This workflow mirrors the [docs](https://github.com/opensearch-project/opensearch-build/tree/main/docs) folder within OpenSearch-Build onto the Wiki.
+
+With this workflow, OpenSearch-Build documentation can be organized within the Wiki tab, while maintaining the ability for contributors to submit reviewable documentation updates in the form of pull requests.
+
+
 ### 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 the fork 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.
 
+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 the fork 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.
+
 ###