Lint markdown in CI, and fix existing lint (sylabs#174)

* Add markdownlint rules yml config

* Fix lint in CHANGELOG.md

* Fix lint in CONTRIBUTING.md

* Fix lint in CONTRIBUTORS.md

* Fix lint in COPYRIGHT.md

* Fix lint in INSTALL.md

* Fix lint in LICENSE*.md

* Fix lint in README.md

* Fix lint in RELEASE_PROCEDURE.md

* Fix lint in SUPPORT.md

* Fix lint in makeit/ MD files

* Fix lint in examples/ MD files

* Remove obsolete docs/2.x files

* Fix lint in e2e/ MD files

* Add markdownlint job to CI config

.circleci/config.yml

@@ -9,6 +9,9 @@ parameters:
     default: 1.16.6
 
 executors:
+  node:
+    docker:
+      - image: node:16-slim
   golang:
     parameters:
       variant:
@@ -103,6 +106,17 @@ commands:
             scripts/ci-docker-run
 
 jobs:
+  lint-markdown:
+    executor: node
+    steps:
+      - run:
+          name: Install markdownlint
+          command: npm install -g markdownlint-cli
+      - checkout
+      - run:
+          name: Check for Lint
+          command: markdownlint .
+
   check-go-mod:
     executor: golang
     steps:
@@ -213,6 +227,7 @@ workflows:
   version: 2
   build_and_test:
     jobs:
+      - lint-markdown
       - check-go-mod
       - build-source-debian
       - build-source-alpine

.markdownlint.yml

@@ -0,0 +1,5 @@
+# Allow repeated headers (changelog sections)
+MD024: false
+# Allow hard tabs (go snippets in e2e)
+MD010: false
+

CONTRIBUTING.md

@@ -1,106 +1,126 @@
-# Contributor's Agreement
-
-You are under no obligation whatsoever to provide any bug fixes, patches,
-or upgrades to the features, functionality or performance of the source
-code ("Enhancements") to anyone; however, if you choose to make your
-Enhancements available either publicly, or directly to the project,
-without imposing a separate written license agreement for such
-Enhancements, then you hereby grant the following license: a non-exclusive,
-royalty-free perpetual license to install, use, modify, prepare derivative
-works, incorporate into other computer software, distribute, and sublicense
-such enhancements or derivative works thereof, in binary and source code
-form.
-
 # Contributing
 
+## Contributor's Agreement
+
+You are under no obligation whatsoever to provide any bug fixes, patches, or
+upgrades to the features, functionality or performance of the source code
+("Enhancements") to anyone; however, if you choose to make your Enhancements
+available either publicly, or directly to the project, without imposing a
+separate written license agreement for such Enhancements, then you hereby grant
+the following license: a non-exclusive, royalty-free perpetual license to
+install, use, modify, prepare derivative works, incorporate into other computer
+software, distribute, and sublicense such enhancements or derivative works
+thereof, in binary and source code form.
+
+## Getting Started
+
 When contributing to SingularityCE, it is important to properly communicate the
 gist of the contribution. If it is a simple code or editorial fix, simply
-explaining this within the GitHub Pull Request (PR) will suffice. But if this
-is a larger fix or Enhancement, you are advised to first discuss the change
-with the project leader or developers.
+explaining this within the GitHub Pull Request (PR) will suffice. But if this is
+a larger fix or Enhancement, you are advised to first discuss the change with
+the project leader or developers.
 
-Please note we have a code of conduct, described below. Please follow it in
-all your interactions with the project members and users.
+Please note we have a code of conduct, described below. Please follow it in all
+your interactions with the project members and users.
 
 ## Pull Requests (PRs)
 
 1. Essential bug fix PRs should be sent to both master and release branches.
-2. Small bug fix and feature enhancement PRs should be sent to master only.
-3. Follow the existing code style precedent, especially for C. For Golang, you
+1. Small bug fix and feature enhancement PRs should be sent to master only.
+1. Follow the existing code style precedent, especially for C. For Golang, you
    will mostly conform to the style and form enforced by the "go fmt" and
    "golint" tools for proper formatting.
-4. For any new functionality, please write appropriate go tests that will run
-   as part of the Continuous Integration (Circle CI) system.
-5. Make sure that the project's default copyright and header have been included
+1. For any new functionality, please write appropriate go tests that will run as
+   part of the Continuous Integration (Circle CI) system.
+1. Make sure that the project's default copyright and header have been included
    in any new source files.
-6. Make sure your code passes linting, by running `make check` before submitting
+1. Make sure your code passes linting, by running `make check` before submitting
    the PR. We use `golangci-lint` as our linter. You may need to address linting
    errors by:
-    - Running `go fmt ./...` to format all `.go` files.
-    - Leaving a function comment on **every** new exported function and package
-      that your PR has introduced. To learn about how to properly comment Golang
-      code, read [this post on golang.org](https://golang.org/doc/effective_go.html?#commentary)
-7. Make sure you have locally tested using `make -C builddir test` and that all
-   tests succeed
-   before submitting the PR.
-8. If possible, run `make -C builddir testall` locally, after setting the
+   - Running `go fmt ./...` to format all `.go` files.
+   - Leaving a function comment on **every** new exported function and package
+     that your PR has introduced. To learn about how to properly comment Golang
+     code, read
+     [this post on golang.org](https://golang.org/doc/effective_go.html#commentary)
+1. Make sure you have locally tested using `make -C builddir test` and that all
+   tests succeed before submitting the PR.
+1. If possible, run `make -C builddir testall` locally, after setting the
    environment variables `E2E_DOCKER_USERNAME` and `E2E_DOCKER_PASSWORD`
    appropriately for an authorized Docker Hub account. This is required as
-   SingularityCE's end-to-end tests preform many tests that build from or execute
-   docker images. Our CI is authorized to run these tests if you cannot.
-9. Ask yourself is the code human understandable? This can be accomplished via a
+   SingularityCE's end-to-end tests preform many tests that build from or
+   execute docker images. Our CI is authorized to run these tests if you cannot.
+1. Ask yourself is the code human understandable? This can be accomplished via a
    clear code style as well as documentation and/or comments.
-10. The pull request will be reviewed by others, and finally merged when all
-    requirements are met.
-11. The `CHANGELOG.md` must be updated for any of the following changes:
-    - Renamed commands
-    - Deprecated / removed commands
-    - Changed defaults / behaviors
-    - Backwards incompatible changes
-    - New features / functionalities
-12. PRs which introduce a new Golang dependency to the project via `go get` and
-    additions to `go.mod` should explain why the dependency is required.
+1. The pull request will be reviewed by others, and finally merged when all
+   requirements are met.
+1. The `CHANGELOG.md` must be updated for any of the following changes:
+   - Renamed commands
+   - Deprecated / removed commands
+   - Changed defaults / behaviors
+   - Backwards incompatible changes
+   - New features / functionalities
+1. PRs which introduce a new Golang dependency to the project via `go get` and
+   additions to `go.mod` should explain why the dependency is required.
 
 ## Documentation
-There are a few places where documentation for the SingularityCE project lives. The [changelog](CHANGELOG.md) is where PRs should include documentation if necessary. When a new release is tagged, the [user-docs](https://www.sylabs.io/guides/latest/user-guide/) and [admin-docs](https://www.sylabs.io/guides/latest/admin-guide/) will be updated using the contents of the `CHANGELOG.md` file as reference.
-
-1. The [changelog](CHANGELOG.md) is a place to document **functional** differences between versions of SingularityCE. PRs which require documentation must update this file. This should be a document which can be used to explain what the new features of each version of SingularityCE are, and should **not** read like a commit log. Once a release is tagged (*e.g. v3.0.0*), a new top level section will be made titled **Changes Since vX.Y.Z** (*e.g. Changes Since v3.0.0*) where new changes will now be documented, leaving the previous section immutable.
-2. The [README](README.md) is a place to document critical information for new users of SingularityCE. It should typically not change, but in the case where a change is necessary a PR may update it.
-3. The [user-docs](https://www.github.com/sylabs/singularity-userdocs) should document anything pertinent to the usage of SingularityCE.
-4. The [admin-docs](https://www.github.com/sylabs/singularity-admindocs) document anything that is pertinent to a system administrator who manages a system with SingularityCE installed.
-5. If necessary, changes to the message displayed when running `singularity help *` can be made by editing `docs/content.go`.
-
-# Code of Conduct
 
-## Our Pledge
+There are a few places where documentation for the SingularityCE project lives.
+The [changelog](CHANGELOG.md) is where PRs should include documentation if
+necessary. When a new release is tagged, the
+[user-docs](https://www.sylabs.io/guides/latest/user-guide/) and
+[admin-docs](https://www.sylabs.io/guides/latest/admin-guide/) will be updated
+using the contents of the `CHANGELOG.md` file as reference.
+
+1. The [changelog](CHANGELOG.md) is a place to document **functional**
+   differences between versions of SingularityCE. PRs which require
+   documentation must update this file. This should be a document which can be
+   used to explain what the new features of each version of SingularityCE are,
+   and should **not** read like a commit log. Once a release is tagged (*e.g.
+   v3.0.0*), a new top level section will be made titled **Changes Since
+   vX.Y.Z** (*e.g. Changes Since v3.0.0*) where new changes will now be
+   documented, leaving the previous section immutable.
+1. The [README](README.md) is a place to document critical information for new
+   users of SingularityCE. It should typically not change, but in the case where
+   a change is necessary a PR may update it.
+1. The [user-docs](https://www.github.com/sylabs/singularity-userdocs) should
+   document anything pertinent to the usage of SingularityCE.
+1. The [admin-docs](https://www.github.com/sylabs/singularity-admindocs)
+   document anything that is pertinent to a system administrator who manages a
+   system with SingularityCE installed.
+1. If necessary, changes to the message displayed when running
+   `singularity help *` can be made by editing `docs/content.go`.
+
+## Code of Conduct
+
+### Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
 
-## Our Standards
+### Our Standards
 
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+- The use of sexualized language or imagery and unwelcome sexual attention or
   advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ### Our Responsibilities
@@ -109,13 +129,13 @@ Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
 response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
 
-## Scope
+### Scope
 
 This Code of Conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community. Examples of
@@ -124,24 +144,23 @@ address, posting via an official social media account, or acting as an appointed
 representative at an online or offline event. Representation of a project may be
 further defined and clarified by project maintainers.
 
-## Enforcement
+### Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior
-may be reported by contacting Jason Tuschen ([email protected]). All
-complaints will be reviewed and investigated and will result in a
-response that is deemed necessary and appropriate to the
-circumstances. The project team is obligated to maintain
-confidentiality with regard to the reporter of an incident. Further
-details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting Jason Tuschen ([email protected]). All complaints will be
+reviewed and investigated and will result in a response that is deemed necessary
+and appropriate to the circumstances. The project team is obligated to maintain
+confidentiality with regard to the reporter of an incident. Further details of
+specific enforcement policies may be posted separately.
 
 Project maintainers, contributors and users who do not follow or enforce the
-Code of Conduct in good faith may face temporary or permanent repercussions
-with their involvement in the project as determined by the project's leader(s).
+Code of Conduct in good faith may face temporary or permanent repercussions with
+their involvement in the project as determined by the project's leader(s).
 
-## Attribution
+### Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
 [version]: http://contributor-covenant.org/version/1/4/