Skip to content

Commit f5bbbf4

Browse files
non-fungible-nelsonnon-fungible-nelson
authored
deprecation notice and addition of docs to the main repo. (#598)
Signed-off-by: Matt Nelson <[email protected]>
1 parent d509f52 commit f5bbbf4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+4316
-0
lines changed

Diff for: ‎README.md

+4
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
# Quorum Key Manager
1010
Quorum Key Manager (QKM) is a key management service developed under the [BSL 1.1](LICENSE) license and written in Go.
1111

12+
Quorum Key Manager is no longer actively maintained by Consensys and is provided as-is. It is an open-source project and contributions are welcome. See the [license](./LICENSE) for more details.
13+
14+
The documentation can now be found [here](./doc.quorum-key-manager-main/) within this repo.
15+
1216
Quorum Key Manager exposes an HTTP API service to manage your secrets, keys and Ethereum accounts. QKM supports the integration with
1317
*AWS Key Management Service*, *Azure Key Vault* and *HashiCorp Vault*.
1418

Diff for: ‎doc.quorum-key-manager-main/.cspell.json

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"version": "0.2",
3+
"gitignoreRoot": ".",
4+
"useGitignore": true,
5+
"dictionaries": [
6+
"css",
7+
"html",
8+
"fonts",
9+
"typescript",
10+
"softwareTerms",
11+
"companies",
12+
"lorem-ipsum",
13+
"project-words"
14+
],
15+
"dictionaryDefinitions": [
16+
{
17+
"name": "project-words",
18+
"path": "./project-words.txt",
19+
"noSuggest": true
20+
}
21+
],
22+
"ignorePaths": [
23+
"CHANGELOG.md",
24+
"LICENSE",
25+
"package.json",
26+
"yarn.lock",
27+
"project-words.txt",
28+
"__snapshots__",
29+
"*.min.*",
30+
"jest/vendor",
31+
"docusaurus.config.js",
32+
"src/css/",
33+
"babel.config.js",
34+
"api/",
35+
"docs/test-api/",
36+
"sidebars.js",
37+
"tsconfig.*.json",
38+
".github/**",
39+
"docs/Tutorials/EddsaBN254Sig.md",
40+
"docs/Tutorials/JsonRPCProxy.md",
41+
"docs/Tutorials/SendMetaTxn.md",
42+
"docs/Reference/CLI/CLI-Syntax.md",
43+
"docs/Tutorials/ConnectInfura.md"
44+
],
45+
"ignoreRegExpList": ["Email", "Urls", "#[\\w-]*"]
46+
}

Diff for: ‎doc.quorum-key-manager-main/.editorconfig

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
charset = utf-8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
indent_style = space
10+
indent_size = 2
11+
max_line_length = 80
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
insert_final_newline = false
16+
trim_trailing_whitespace = false

Diff for: ‎doc.quorum-key-manager-main/.eslintignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
build/
2+
.eslintrc.js
3+
docs/test-api
4+
./node_modules/*
5+
*.md
6+
*.mdx
7+
LICENSE

Diff for: ‎doc.quorum-key-manager-main/.eslintrc.js

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
module.exports = {
2+
env: {
3+
browser: true,
4+
es2021: true,
5+
},
6+
extends: [
7+
"plugin:react/recommended",
8+
"airbnb-typescript",
9+
"plugin:import/typescript",
10+
// @NOTE: Make sure this is always the last element in the array.
11+
"plugin:prettier/recommended",
12+
],
13+
parser: "@typescript-eslint/parser",
14+
parserOptions: {
15+
ecmaVersion: 2020,
16+
sourceType: "module",
17+
ecmaFeatures: {
18+
jsx: true,
19+
},
20+
project: ["./tsconfig.json"],
21+
},
22+
plugins: [
23+
"react",
24+
"react-hooks",
25+
"jsx-a11y",
26+
"import",
27+
"prettier",
28+
"@typescript-eslint",
29+
],
30+
settings: {
31+
react: {
32+
pragma: "React", // Pragma to use, default to "React"
33+
fragment: "Fragment", // Fragment to use (may be a property of <pragma>), default to "Fragment"
34+
version: "detect", // React version. "detect" automatically picks the version you have installed.
35+
// You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
36+
// default to latest and warns if missing
37+
// It will default to "detect" in the future
38+
},
39+
"import/parsers": {
40+
"@typescript-eslint/parser": [".ts", ".tsx"],
41+
},
42+
"import/resolver": {
43+
typescript: {},
44+
},
45+
},
46+
rules: {
47+
"import/prefer-default-export": 0,
48+
"react/prop-types": 0,
49+
"import/no-unresolved": [
50+
"error",
51+
{ ignore: ["^@theme", "^@docusaurus", "^@site"] },
52+
],
53+
"no-nested-ternary": 0,
54+
"no-console": 0,
55+
"no-unused-vars": 0,
56+
"no-use-before-define": 0,
57+
"arrow-body-style": 0,
58+
"jsx-a11y/anchor-is-valid": 0,
59+
"jsx-a11y/no-static-element-interactions": 0,
60+
"jsx-a11y/click-events-have-key-events": 0,
61+
"@typescript-eslint/no-unused-expressions": 0,
62+
"@typescript-eslint/no-unused-vars": ["warn", { args: "none" }],
63+
"@typescript-eslint/no-use-before-define": "warn",
64+
"react/require-default-props": 0,
65+
"react/jsx-props-no-spreading": 0,
66+
"react/button-has-type": 0,
67+
"jsx-a11y/label-has-associated-control": [
68+
"error",
69+
{
70+
labelComponents: [],
71+
labelAttributes: [],
72+
controlComponents: [],
73+
assert: "either",
74+
depth: 2,
75+
},
76+
],
77+
"@typescript-eslint/naming-convention": [
78+
"error",
79+
{
80+
selector: "variableLike",
81+
leadingUnderscore: "forbid",
82+
trailingUnderscore: "forbid",
83+
format: ["camelCase", "PascalCase", "UPPER_CASE"],
84+
},
85+
],
86+
"import/extensions": 0,
87+
},
88+
};

Diff for: ‎doc.quorum-key-manager-main/.github/ISSUE_TEMPLATE/bug_report.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report.
4+
title: ""
5+
labels: Documentation
6+
assignees: Ezzahhh
7+
---
8+
9+
## Describe the bug
10+
11+
<!-- Add a clear and concise description of what the documentation bug is.
12+
Include steps to reproduce the bug and what you expected to happen. -->
13+
14+
## System settings
15+
16+
<!-- Add the following information about your system: -->
17+
18+
- OS and version:
19+
- Browser and version:
20+
- Plugins activated in your browser:
21+
22+
## More context
23+
24+
<!-- Add any other context about the problem here, for example, screenshots or a small demo video. -->

Diff for: ‎doc.quorum-key-manager-main/.github/pull_request_template.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Pull request checklist
2+
3+
Use the following template to make sure your PR fits the ConsenSys documentation standard.
4+
5+
## Before creating the PR
6+
7+
Make sure that:
8+
9+
- [ ] You've read the [contribution guidelines](https://consensys.net/docs/doctools/).
10+
- [ ] You've [previewed your changes locally](https://consensys.net/docs/doctools/en/latest/preview/new-system/#preview-locally).
11+
12+
## Describe the change
13+
14+
<!-- Add a clear and concise description of what your PR changes in the documentation. -->
15+
16+
## Issue fixed
17+
18+
<!-- Link to the GitHub issue that your PR addresses.
19+
20+
Add "fixes #{your issue number}" to close the issue automatically when the PR is merged.
21+
22+
If your PR doesn't completely fix the issue, add "see #{your issue number}" to link to the issue
23+
without automatically closing it. -->
24+
25+
## Impacted parts
26+
27+
<!-- Check the item from the following lists that your PR impacts. You can check multiple boxes. -->
28+
29+
For content changes:
30+
31+
- [ ] Documentation content
32+
- [ ] Documentation page organization
33+
34+
For tool changes:
35+
36+
- [ ] Build and QA tools
37+
- [ ] MkDocs templates
38+
- [ ] MkDocs configuration
39+
- [ ] Python dependencies
40+
- [ ] Node dependencies and JavaScript
41+
- [ ] GitHub integration
42+
43+
## After creating your PR and tests have finished
44+
45+
Make sure that:
46+
47+
- [ ] You've [fixed any issues](https://consensys.net/docs/doctools/en/latest/contribute/fix-cicd-errors/) raised by the tests.
48+
- [ ] You've previewed your changes on Vercel below.

Diff for: ‎doc.quorum-key-manager-main/.github/workflows/build.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Build
3+
4+
on:
5+
workflow_call:
6+
# Review gh actions docs if you want to further define triggers, paths, etc
7+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
8+
9+
jobs:
10+
build:
11+
name: Build
12+
runs-on: ubuntu-latest
13+
# the enviroment to deploy to / use secrets from
14+
environment: no-secret
15+
# modify the default permissions of the GITHUB_TOKEN, so as to only allow least priveleges
16+
permissions:
17+
contents: read
18+
steps:
19+
- uses: actions/checkout@v3
20+
21+
- name: Build
22+
uses: ConsenSys/docs-gha/build@main
23+
with:
24+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Diff for: ‎doc.quorum-key-manager-main/.github/workflows/case.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Check file name case
3+
4+
on:
5+
pull_request:
6+
branches:
7+
- main
8+
workflow_call:
9+
10+
jobs:
11+
case:
12+
name: Check for case being inconsistent
13+
runs-on: ubuntu-latest
14+
strategy:
15+
matrix:
16+
folder: ["docs"]
17+
# the enviroment to deploy to / use secrets from
18+
environment: no-secret
19+
# modify the default permissions of the GITHUB_TOKEN, so as to only allow least priveleges
20+
permissions:
21+
contents: read
22+
steps:
23+
- uses: actions/checkout@v3
24+
25+
- name: Case check action
26+
uses: ConsenSys/docs-gha/case@main
27+
with:
28+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
29+
DOC_DIR: ${{ matrix.folder }}
30+
SKIP_TEST: true

Diff for: ‎doc.quorum-key-manager-main/.github/workflows/lint.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Check for lint/build errors
3+
4+
on:
5+
pull_request:
6+
branches:
7+
- main
8+
workflow_call:
9+
10+
jobs:
11+
lint:
12+
name: Lint Code Base, Spelling, Link Check
13+
runs-on: ubuntu-latest
14+
# the enviroment to deploy to / use secrets from
15+
environment: no-secret
16+
# modify the default permissions of the GITHUB_TOKEN, so as to only allow least priveleges
17+
permissions:
18+
contents: read
19+
steps:
20+
- uses: actions/checkout@v3
21+
22+
- name: Lint
23+
uses: ConsenSys/docs-gha/lint@main
24+
with:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26+
27+
linkCheck:
28+
name: Link Checking
29+
runs-on: ubuntu-latest
30+
environment: no-secret
31+
strategy:
32+
matrix:
33+
file-extensions: [".md", ".mdx"]
34+
steps:
35+
- uses: actions/checkout@v3
36+
- name: LinkCheck
37+
uses: ConsenSys/docs-gha/linkcheck@main
38+
with:
39+
FILE_EXTENSION: ${{ matrix.file-extensions }}

Diff for: ‎doc.quorum-key-manager-main/.github/workflows/release.yaml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Release
3+
4+
on:
5+
push:
6+
branches:
7+
- main
8+
# Review gh actions docs if you want to further define triggers, paths, etc
9+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
10+
11+
jobs:
12+
lint:
13+
uses: ./.github/workflows/lint.yml
14+
case:
15+
uses: ./.github/workflows/case.yml
16+
build:
17+
needs: [lint, case]
18+
uses: ./.github/workflows/build.yml
19+
release:
20+
needs: build
21+
name: Create Release
22+
runs-on: ubuntu-latest
23+
# the enviroment to deploy to / use secrets from
24+
environment: no-secret
25+
# modify the default permissions of the GITHUB_TOKEN, so as to only allow least priveleges
26+
permissions:
27+
contents: write
28+
issues: write
29+
pull-requests: write
30+
steps:
31+
- uses: actions/checkout@v3
32+
- name: Release
33+
uses: ConsenSys/docs-gha/release@main
34+
with:
35+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)