From 354c2ced3388e2b535e4b27f3746a825c6a4830a Mon Sep 17 00:00:00 2001
From: Peter Somogyvari <peter.somogyvari@accenture.com>
Date: Wed, 22 Nov 2023 10:51:08 -0800
Subject: [PATCH] style: fix DCI-Lint errors in docs and sawtooth connector

1. Some of the documentation configuration files got moved around during
the latest refactor and the .dcilintignore file's contents were not updated
to match the new directory paths so this change ensure that the ignore file
is up to date with the latest location of the files in the directory
structure.
2. The sawtooth connector's open api generator output was not being set
up with the correct ignore file so some of the generated scripts that we
don't need got snuck into version control and these were also containing
banned keywords. I updated the ignore file and removed the extranous files
from version control (git_push.sh, .npmignore, .gitignore)

[skip ci]

Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
---
 .dcilintignore                                |  5 +-
 docs/docs/contributing/how-to-contribute.md   |  2 +-
 .../openapi/typescript-axios/.gitignore       |  4 --
 .../openapi/typescript-axios/.npmignore       |  1 -
 .../.openapi-generator-ignore                 |  4 ++
 .../openapi/typescript-axios/git_push.sh      | 57 -------------------
 .../main/typescript/sawtooth-api/.gitignore   |  4 --
 .../main/typescript/sawtooth-api/.npmignore   |  1 -
 .../sawtooth-api/.openapi-generator-ignore    |  4 ++
 .../main/typescript/sawtooth-api/git_push.sh  | 57 -------------------
 10 files changed, 13 insertions(+), 126 deletions(-)
 delete mode 100644 packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.gitignore
 delete mode 100644 packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.npmignore
 delete mode 100644 packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/git_push.sh
 delete mode 100644 packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.gitignore
 delete mode 100644 packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.npmignore
 delete mode 100644 packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/git_push.sh

diff --git a/.dcilintignore b/.dcilintignore
index d06a458b3d..40966ec9cb 100644
--- a/.dcilintignore
+++ b/.dcilintignore
@@ -5,7 +5,10 @@ tools/docker/besu-all-in-one/supervisord.conf
 .yarn/**
 
 # Cannot be edited due to configuration schema of third party software
-docs/source/conf.py
+docs-cactus/source/conf.py
+
+# Links would be broken if we refactored the offending lines
+docs/docs/contributing/requesting-a-change.md
 
 # Cannot be edited due to configuration schema of third party software
 examples/register-indy-data/register-indy-data.py
diff --git a/docs/docs/contributing/how-to-contribute.md b/docs/docs/contributing/how-to-contribute.md
index 24593aad55..145a57dd82 100644
--- a/docs/docs/contributing/how-to-contribute.md
+++ b/docs/docs/contributing/how-to-contribute.md
@@ -38,7 +38,7 @@ enhancement. Here are some example scenarios:
 * If a PR is opened with several commits, where the first commit fixes one issue and the rest fix a separate issue, the PR should be rebased to two commits (one for each issue).
 
 !!! important
-    Your pull request should be rebased against the current master branch. Do not merge the current master branch in with your topic branch. Do not use the Update Branch button provided by GitHub on the pull request page.
+    Your pull request should be rebased against the current main branch. Do not merge the current main branch in with your topic branch. Do not use the Update Branch button provided by GitHub on the pull request page.
 
 ### Commit Messages
 
diff --git a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.gitignore b/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.gitignore
deleted file mode 100644
index 149b576547..0000000000
--- a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.gitignore
+++ /dev/null
@@ -1,4 +0,0 @@
-wwwroot/*.js
-node_modules
-typings
-dist
diff --git a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.npmignore b/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.npmignore
deleted file mode 100644
index 999d88df69..0000000000
--- a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.npmignore
+++ /dev/null
@@ -1 +0,0 @@
-# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm
\ No newline at end of file
diff --git a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.openapi-generator-ignore b/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.openapi-generator-ignore
index 7484ee590a..9548c6c685 100644
--- a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.openapi-generator-ignore
+++ b/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/.openapi-generator-ignore
@@ -21,3 +21,7 @@
 #docs/*.md
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
+
+.gitignore
+.npmignore
+git_push.sh
\ No newline at end of file
diff --git a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/git_push.sh b/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/git_push.sh
deleted file mode 100644
index f53a75d4fa..0000000000
--- a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/generated/openapi/typescript-axios/git_push.sh
+++ /dev/null
@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'
diff --git a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.gitignore b/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.gitignore
deleted file mode 100644
index 149b576547..0000000000
--- a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.gitignore
+++ /dev/null
@@ -1,4 +0,0 @@
-wwwroot/*.js
-node_modules
-typings
-dist
diff --git a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.npmignore b/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.npmignore
deleted file mode 100644
index 999d88df69..0000000000
--- a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.npmignore
+++ /dev/null
@@ -1 +0,0 @@
-# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm
\ No newline at end of file
diff --git a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.openapi-generator-ignore b/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.openapi-generator-ignore
index 7484ee590a..9548c6c685 100644
--- a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.openapi-generator-ignore
+++ b/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/.openapi-generator-ignore
@@ -21,3 +21,7 @@
 #docs/*.md
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
+
+.gitignore
+.npmignore
+git_push.sh
\ No newline at end of file
diff --git a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/git_push.sh b/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/git_push.sh
deleted file mode 100644
index f53a75d4fa..0000000000
--- a/packages/cactus-plugin-ledger-connector-sawtooth/src/main/typescript/sawtooth-api/git_push.sh
+++ /dev/null
@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'