Skip to content

Commit

Permalink
style: fix DCI-Lint errors in docs and sawtooth connector
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
petermetz committed Nov 22, 2023
1 parent 0af2eb1 commit 354c2ce
Show file tree
Hide file tree
Showing 10 changed files with 13 additions and 126 deletions.
5 changes: 4 additions & 1 deletion .dcilintignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributing/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

.gitignore
.npmignore
git_push.sh

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

.gitignore
.npmignore
git_push.sh

This file was deleted.

0 comments on commit 354c2ce

Please sign in to comment.