Merge pull request #177 from marklogic-community/release/1.3.0

Merging doc changes into master

Author: rjrudin

.editorconfig

@@ -12,5 +12,5 @@ insert_final_newline = true
 [*.md]
 trim_trailing_whitespace = false
 
-[*.mdown]
-trim_trailing_whitespace = false
+[*.java]
+indent_size = 4

.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,50 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["develop"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs/
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

CODEOWNERS

@@ -0,0 +1,5 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in the repo.
+* @anu3990 @billfarber @rjrudin

CONTRIBUTING.md

@@ -26,172 +26,21 @@ the marklogic-junit5 subproject will also hit the MarkLogic App-Services app ser
 After running `./gradlew test`, you can also point your browser at http://localhost:8008/test to access the 
 marklogic-unit-test UI for running tests. 
 
-## <a name="issue"></a> Found an Issue?
-If you find a bug in the source code or a mistake in the documentation, you can 
-help us by submitting an issue to our [GitHub Issue Tracker][issue tracker]. 
-Even better you can submit a Pull Request with a fix for the issue you filed.
+## Testing the documentation locally
 
-## <a name="feature"></a> Want a Feature?
-You can request a new feature by submitting an issue to our 
-[GitHub Issue Tracker][issue tracker]. If youwould like to implement a new 
-feature then first create a new issue and discuss it with one of our project 
-maintainers.
+The docs for this project are stored in the `./docs` directory as a set of Markdown files. These are published via
+[GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages) using the
+configuration found under "Settings / Pages" in this repository.
 
-## <a name="submit"></a> Submission Guidelines
+You can build and test the docs locally by
+[following these GitHub instructions](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll),
+though you don't need to perform all of those steps since some files generated by doing so are already in the
+`./docs` directory. You just need to do the following:
 
-### Submitting an Issue
-Before you submit your issue search the archive. 
+1. Install the latest Ruby (rbenv works well for this).
+2. Install Jekyll.
+3. Go to the docs directory - `cd ./docs` .
+4. Run `bundle install` (this may not be necessary due to Gemfile.lock being in version control).
+5. Run `bundle exec jekyll serve`.
 
-If your issue appears to be a bug, and hasn't been reported, open a new issue.
-Help us to maximize the effort we can spend fixing issues and adding new
-features by not reporting duplicate issues. Providing the following 
-information will increase the chances of your issue being dealt with quickly:
-
-* **Overview of the Issue** - if an error is being thrown a stack trace helps
-* **Motivation for or Use Case** - explain why this is a bug for you
-* **marklogic-unit-test Version** - is it a named version or from our dev branch
-* **Operating System** - Mac, windows? details help
-* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
-  causing the problem (line of code or commit)
-
-### Submitting a Pull Request
-
-#### Fork marklogic-unit-test
-
-Fork the project [on GitHub](https://github.com/marklogic-community/marklogic-unit-test/fork) and clone
-your copy.
-
-```sh
-$ git clone [email protected]:username/marklogic-unit-test.git
-$ cd marklogic-unit-test
-$ git remote add upstream git://github.com/marklogic-community/marklogic-unit-test.git
-```
-
-All bug fixes and new features go into the dev branch.
-
-We ask that you open an issue in the [issue tracker][] and get agreement from
-at least one of the project maintainers before you start coding.
-
-Nothing is more frustrating than seeing your hard work go to waste because
-your vision does not align with that of a project maintainer.
-
-#### Create a branch for your changes
-
-Okay, so you have decided to fix something. Create a feature branch
-and start hacking:
-
-```sh
-$ git checkout -b my-feature-branch -t origin/dev
-```
-
-#### Formatting code
-
-We use [.editorconfig][] to configure our editors for proper code formatting. If you don't
-use a tool that supports editorconfig be sure to configure your editor to use the settings
-equivalent to our .editorconfig file.
-
-#### Commit your changes
-
-Make sure git knows your name and email address:
-
-```sh
-$ git config --global user.name "J. Random User"
-$ git config --global user.email "[email protected]"
-```
-
-Writing good commit logs is important. A commit log should describe what
-changed and why. Follow these guidelines when writing one:
-
-1. The first line should be 50 characters or less and contain a short
-   description of the change including the Issue number prefixed by a hash (#).
-2. Keep the second line blank.
-3. Wrap all other lines at 72 columns.
-
-A good commit log looks like this:
-
-```
-Fixing Issue #123: make the whatchamajigger work in MarkLogic 8
-
-Body of commit message is a few lines of text, explaining things
-in more detail, possibly giving some background about the issue
-being fixed, etc etc.
-
-The body of the commit message can be several paragraphs, and
-please do proper word-wrap and keep columns shorter than about
-72 characters or so. That way `git log` will show things
-nicely even when it is indented.
-```
-
-The header line should be meaningful; it is what other people see when they
-run `git shortlog` or `git log --oneline`.
-
-#### Rebase your repo
-
-Use `git rebase` (not `git merge`) to sync your work from time to time.
-
-```sh
-$ git fetch upstream
-$ git rebase upstream/dev
-```
-
-#### Test your code
-
-We are working hard to improve marklogic-unit-test's testing. If you add new functions
-then please write unit tests in `marklogic-unit-test-client/src/test/ml-modules/root/test/suites/`. 
-When finished, verify that the self-test works. See the instructions for Building and Testing at the top of this 
-guide for doing so.
-
-For modifications to code in the ./marklogic-junit 5 project, please see the README file in that project. 
-
-Make sure that all tests pass. Please, do not submit patches that fail.
-
-#### Push your changes
-
-```sh
-$ git push origin my-feature-branch
-```
-
-#### Submit the pull request
-
-Go to https://github.com/username/marklogic-unit-test and select your feature branch. 
-Click the 'Pull Request' button and fill out the form.
-
-Pull requests are usually reviewed within a few days. If you get comments that 
-need to be to addressed, apply your changes in a separate commit and push that 
-to your feature branch. Post a comment in the pull request afterwards; GitHub 
-does not send out notifications when you add commits to existing pull requests.
-
-That's it! Thank you for your contribution!
-
-
-#### After your pull request is merged
-
-After your pull request is merged, you can safely delete your branch and pull the changes
-from the main (upstream) repository:
-
-* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
-
-    ```shell
-    git push origin --delete my-feature-branch
-    ```
-
-* Check out the dev branch:
-
-    ```shell
-    git checkout dev -f
-    ```
-
-* Delete the local branch:
-
-    ```shell
-    git branch -D my-feature-branch
-    ```
-
-* Update your dev with the latest upstream version:
-
-    ```shell
-    git pull --ff upstream dev
-    ```
-
-[issue tracker]: https://github.com/marklogic/marklogic-unit-test/issues
-[.editorconfig]: http://editorconfig.org/
+You can then go to http://localhost:4000 to view the docs. 

Jenkinsfile

@@ -0,0 +1,46 @@
+@Library('shared-libraries') _
+pipeline{
+  agent {label 'devExpLinuxPool'}
+  options {
+    checkoutToSubdirectory 'marklogic-unit-test'
+    buildDiscarder logRotator(artifactDaysToKeepStr: '7', artifactNumToKeepStr: '', daysToKeepStr: '30', numToKeepStr: '')
+  }
+  environment{
+    JAVA_HOME_DIR="/home/builder/java/jdk-11.0.2"
+    GRADLE_DIR   =".gradle"
+    DMC_USER     = credentials('MLBUILD_USER')
+    DMC_PASSWORD = credentials('MLBUILD_PASSWORD')
+  }
+  stages{
+    stage('tests'){
+      steps{
+        copyRPM 'Release','11.0.0'
+        setUpML '$WORKSPACE/xdmp/src/Mark*.rpm'
+        sh label:'test', script: '''#!/bin/bash
+          export JAVA_HOME=$JAVA_HOME_DIR
+          export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
+          export PATH=$GRADLE_USER_HOME:$JAVA_HOME/bin:$PATH
+          cd marklogic-unit-test
+          echo "mlPassword=admin" > marklogic-junit5/gradle-local.properties
+          ./gradlew test  -PmlPassword=admin || true
+        '''
+        junit '**/build/**/*.xml'
+      }
+    }
+    stage('publish'){
+			when {
+      	branch 'develop'
+      }
+      steps{
+      	sh label:'publish', script: '''#!/bin/bash
+        	export JAVA_HOME=$JAVA_HOME_DIR
+          export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
+          export PATH=$GRADLE_USER_HOME:$JAVA_HOME/bin:$PATH
+          cp ~/.gradle/gradle.properties $GRADLE_USER_HOME;
+          cd marklogic-unit-test
+           ./gradlew publish
+        '''
+      }
+    }
+  }
+}