Merge pull request #2765 from swcurran/organize-docs

Reorganize the ACA-Py Documentation Files

CODE_OF_CONDUCT.md

@@ -151,16 +151,18 @@ and any kind of face-to-face meetings or discussions.
 ## Incident Procedure
 
 To report incidents or to appeal reports of incidents, send email to Mike Dolan
-([email protected]) or Angela Brown ([email protected]). Please include any
-available relevant information, including links to any publicly accessible material relating to the
-matter. Every effort will be taken to ensure a safe and collegial environment in which to
-collaborate on matters relating to the Project. In order to protect the community, the Project
-reserves the right to take appropriate action, potentially including the removal of an individual
-from any and all participation in the project. The Project will work towards an equitable resolution
-in the event of a misunderstanding.
+([[email protected]](mailto:[email protected])) or Angela
+Brown ([[email protected]](mailto:[email protected])). Please
+include any available relevant information, including links to any publicly
+accessible material relating to the matter. Every effort will be taken to ensure
+a safe and collegial environment in which to collaborate on matters relating to
+the Project. In order to protect the community, the Project reserves the right
+to take appropriate action, potentially including the removal of an individual
+from any and all participation in the project. The Project will work towards an
+equitable resolution in the event of a misunderstanding.
 
 ## Credits
 
 This code is based on the
 [W3C’s Code of Ethics and Professional Conduct](https://www.w3.org/Consortium/cepc) with some
-additions from the [Cloud Foundry](https://www.cloudfoundry.org/)‘s Code of Conduct.
+additions from the [Cloud Foundry](https://www.cloudfoundry.org/)‘s Code of Conduct.

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-## How to contribute
+# How to contribute
 
 You are encouraged to contribute to the repository by **forking and submitting a pull request**.
 
@@ -21,12 +21,12 @@ A configuration for [pre-commit](https://pre-commit.com/) is included in this re
 
 On each commit, pre-commit hooks will run that verify the committed code complies with ruff and is formatted with black. To install the ruff and black checks:
 
-```
-$ pre-commit install
+```bash
+pre-commit install
 ```
 
 To install the commit message linter:
 
-```
-$ pre-commit install --hook-type commit-msg
+```bash
+pre-commit install --hook-type commit-msg
 ```

PUBLISHING.md

@@ -72,7 +72,7 @@ s/^/- /
   merged:>2022-04-07`) and for each page, highlight, and copy the text
   of only the list of PRs on the page to use in the following step.
 - For each page, run the command
-  `sed -e :a -e '$!N;s/\n#/ #/;ta' -e 'P;D' <<EOF | sed -f changelog.sed`, 
+  `sed -e :a -e '$!N;s/\n#/ #/;ta' -e 'P;D' <<EOF | sed -f changelog.sed`,
   paste in the copied text and then type `EOF`.
   Redirect the output to a file, appending each page of output to the file.
   - The first `sed` command in the pipeline merges the PR title and PR number
@@ -103,9 +103,9 @@ Once you have the list of PRs:
    `./scripts/generate-open-api-spec`.
 
 6. Update the version number listed in
-   [pyproject.toml](pyproject.toml) and, prefixed with
-   a "v" in [open-api/openapi.json](open-api/openapi.json) and
-   [open-api/swagger.json](open-api/swagger.json) (e.g. "0.7.2" in the
+   [pyproject.toml](https://github.com/hyperledger/aries-cloudagent-python/tree/main/pyproject.toml) and, prefixed with
+   a "v" in [open-api/openapi.json](https://github.com/hyperledger/open-api/tree/main/openapi.json) and
+   [open-api/swagger.json](https://github.com/hyperledger/open-api/tree/main/swagger.json) (e.g. "0.7.2" in the
    pyproject.toml file and "v0.7.2" in the openapi.json file). The incremented
    version number should adhere to the [Semantic Versioning
    Specification](https://semver.org/#semantic-versioning-specification-semver)
@@ -131,7 +131,7 @@ Once you have the list of PRs:
 
 10. Immediately after it is merged, create a new GitHub tag representing the
    version. The tag name and title of the release should be the same as the
-   version in [pyproject.toml](pyproject.toml). Use
+   version in [pyproject.toml](https://github.com/hyperledger/aries-cloudagent-python/tree/main/pyproject.toml). Use
    the "Generate Release Notes" capability to get a sequential listing of the
    PRs in the release, to complement the manually curated Changelog. Verify on
    PyPi that the version is published.
@@ -145,11 +145,10 @@ Once you have the list of PRs:
    "Packages").
 
    Additional information about the container image publication process can be
-   found in the document [Container Images and Github Actions]().
+   found in the document [Container Images and Github Actions](docs/deploying/ContainerImagesAndGithubActions.md).
 
 [publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/.github/workflows/publish.yml
 [publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/.github/workflows/publish-indy.yml
-[Container Images and Github Actions]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/ContainerImagesAndGithubActions.md
 
 12. Update the ACA-Py Read The Docs site by building the new "latest" (main
     branch) and activating and building the new release. Appropriate permissions