diff --git a/.github/workflows/publish-wiki.yml b/.github/workflows/publish-wiki.yml new file mode 100644 index 000000000..6ac14f167 --- /dev/null +++ b/.github/workflows/publish-wiki.yml @@ -0,0 +1,33 @@ +name: Publish ARM Wiki Update + +on: + push: + branches: [main] + paths: + - arm_wiki/** + pull_request_review: + types: [submitted] + gollum: + +env: + GIT_AUTHOR_NAME: Actionbot + GIT_AUTHOR_EMAIL: actions@github.com + +permissions: + contents: write + +jobs: + job-sync-docs-to-wiki: + runs-on: ubuntu-latest + if: github.event_name != 'gollum' + steps: + - name: Checkout Repo + uses: actions/checkout@v2 + - name: Sync arm docs to wiki + uses: newrelic/wiki-sync-action@main + with: + source: arm_wiki + destination: wiki + token: ${{ secrets.ARM_WIKI_TOKEN }} + gitAuthorName: ${{ env.GIT_AUTHOR_NAME }} + gitAuthorEmail: ${{ env.GIT_AUTHOR_EMAIL }} \ No newline at end of file diff --git a/arm_wiki/ARM-Development-Tools.md b/arm_wiki/ARM-Development-Tools.md new file mode 100644 index 000000000..ad00f0691 --- /dev/null +++ b/arm_wiki/ARM-Development-Tools.md @@ -0,0 +1,179 @@ +## Overview +To support development of ARM, some of the more tedious and repetitious development tasks have been wrapped up into the ARM Development Tools. The developer tools (devtools) are designed to help out anyone contributing to ARM and save time when testing out any changes being made. + +To run devtools, navigate to the arm devtools folder and run the python file, armdevtools.py. + +_Note: if the file is not executable, run `chown u+x armdevtools.py`_ + +`cd devtools` + +## Running devtools + +There are various commands available to the developer, as detailed below. The general output from the devtools follows: + +``` +INFO: +INFO: Going to stop ARMUI - requesting sudo +INFO: ARM UI stopped [Ok] +INFO: ------------------------------------- +INFO: +INFO: