Skip to content

Commit

Permalink
docusaurus3 upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuafernandes committed Nov 29, 2023
1 parent f8d0eb0 commit f4298df
Show file tree
Hide file tree
Showing 9 changed files with 10,263 additions and 14,455 deletions.
91 changes: 10 additions & 81 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,88 +1,17 @@
module.exports = {
env: {
browser: true,
es2021: true,
},
extends: [
"plugin:react/recommended",
"airbnb-typescript",
"plugin:import/typescript",
// @NOTE: Make sure this is always the last element in the array.
"plugin:prettier/recommended",
],
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaVersion: 2020,
sourceType: "module",
ecmaFeatures: {
jsx: true,
},
project: ["./tsconfig.json"],
},
plugins: [
"react",
"react-hooks",
"jsx-a11y",
"import",
"prettier",
"@typescript-eslint",
"plugin:@docusaurus/recommended",
],
settings: {
react: {
pragma: "React", // Pragma to use, default to "React"
fragment: "Fragment", // Fragment to use (may be a property of <pragma>), default to "Fragment"
version: "detect", // React version. "detect" automatically picks the version you have installed.
// You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
// default to latest and warns if missing
// It will default to "detect" in the future
},
"import/parsers": {
"@typescript-eslint/parser": [".ts", ".tsx"],
},
"import/resolver": {
typescript: {},
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module",
"ecmaFeatures": {
"jsx": true
},
project: ["./tsconfig.json"]
},
rules: {
"import/prefer-default-export": 0,
"react/prop-types": 0,
"import/no-unresolved": [
"error",
{ ignore: ["^@theme", "^@docusaurus", "^@site"] },
],
"no-nested-ternary": 0,
"no-console": 0,
"no-unused-vars": 0,
"no-use-before-define": 0,
"arrow-body-style": 0,
"jsx-a11y/anchor-is-valid": 0,
"jsx-a11y/no-static-element-interactions": 0,
"jsx-a11y/click-events-have-key-events": 0,
"@typescript-eslint/no-unused-expressions": 0,
"@typescript-eslint/no-unused-vars": ["warn", { args: "none" }],
"@typescript-eslint/no-use-before-define": "warn",
"react/require-default-props": 0,
"react/jsx-props-no-spreading": 0,
"react/button-has-type": 0,
"jsx-a11y/label-has-associated-control": [
"error",
{
labelComponents: [],
labelAttributes: [],
controlComponents: [],
assert: "either",
depth: 2,
},
],
"@typescript-eslint/naming-convention": [
"error",
{
selector: "variableLike",
leadingUnderscore: "forbid",
trailingUnderscore: "forbid",
format: ["camelCase", "PascalCase", "UPPER_CASE"],
},
],
"import/extensions": 0,
'@docusaurus/no-untranslated-text': 0
},
};
};
28 changes: 0 additions & 28 deletions .github/workflows/case.yml

This file was deleted.

8 changes: 4 additions & 4 deletions docs/HowTo/Generate-certificates.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Follow these steps to use a public IP address as CN.

2. Test whether the certificate was generated with the expected subject alternative names:

<Tabs>
<Tabs>

<TabItem value="Command" label="Command" default>

Expand All @@ -128,7 +128,7 @@ Follow these steps to use a public IP address as CN.
[...]
```
</TabItem>
</Tabs>
</Tabs>

### Generating a new certificate

Expand All @@ -140,7 +140,7 @@ Follow these steps to use a public IP address as CN.

2. Test whether the generated certificate contains the subject alternative names:

<Tabs>
<Tabs>

<TabItem value="Command" label="Command" default>

Expand All @@ -163,4 +163,4 @@ Follow these steps to use a public IP address as CN.
```

</TabItem>
</Tabs>
</Tabs>
10 changes: 5 additions & 5 deletions docs/HowTo/Use/Logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,21 @@ JAVA_OPTS="-Dlogback.configurationFile=/path/to/logback.xml" tessera --configfil
The following is a non-exhaustive list of error messages and suggested actions. Braces '{}' indicate where further detail of the root cause is logged as part of the message.

| Message | Cause |
| --- | --- | --- |
| --- | --- |
| `Error decoding message: {error details}` | Invalid base64 in privateFrom/privateFor from the privacy-enabled Ethereum client, or in transaction hash for resend.<br />**Action**: _Sender needs to provide valid base64_ |
| `Error occurred: {error details} Root cause: {root cause}` | Generated for a variety of reasons:<br /><br /> - Invalid content in message, example: <br /><pre>curl -X POST "http://localhost:9001/push" \<br /> -H "accept: application/json" \<br /> -H "Content-Type: application/octet-stream" \<br /> -d "[ \"a garbage string\"]"</pre>- Could not send message to peer, example: <br /><pre>"Root cause: Unable to push payload to recipient url<br />http://localhost:9001/"<br /></pre>**Action**: _depends on the root cause in the log message_ |
| `Error occurred: {error details} Root cause: {root cause}` | Generated for a variety of reasons:<br /><br /> - Invalid content in message, example: ```curl -X POST "http://localhost:9001/push" -H "accept: application/json" -H "Content-Type: application/octet-stream" -d [ "a garbage string"] ```<br /><br /> - Could not send message to peer, example: <br /><pre>Root cause: Unable to push payload to recipient url ```http://localhost:9001/"```<br /></pre>**Action**: _depends on the root cause in the log message_ |
| `Enclave unavailable: {error details}` | **Action**: _user needs to check why enclave is unavailable (look in log file for enclave)_ |
| `Entity not found: {error details}` | API request received against q2tserver/transaction/{key} where key is not a transaction hash in the DB |
| `Entity not found: {error details}` | API request received against `q2tserver/transaction/{key}` where key is not a transaction hash in the DB |
| `Entity not found:{error details}` | Thrown if endpoint doesn't exist on that API, example:<br /><pre>curl -s http://localhost:9001/invalidendpoint</pre> |
| `Security exception {followed by exception message, example "java.lang.SecurityException: No key found for url 127.1.1.1"}` | Thrown if enableRemoteKeyValidation: true and partyinfo request received from a URL of a node for which we don't hold a public key (for example potentially a malicious party).Note: if key validation enabled then this exception will be thrown during startup whilst the nodes exchange key information. |
| `ERROR c.q.t.a.e.DefaultExceptionMapper - HTTP 400 Bad Request` | Logged if received message is corrupt/incorrectly formatted, example: <br /><pre>curl -X POST "http://localhost:9001/resend" \<br /> -H "accept: text/plain" \<br /> -H "Content-Type: application/json" \<br /> -d "{ \"some rubbish\" }"</pre> |
| `ERROR c.q.t.a.e.DefaultExceptionMapper - HTTP 400 Bad Request` | Logged if received message is corrupt/incorrectly formatted, example: ```curl -X POST "http://localhost:9001/resend" -H "accept: text/plain" -H "Content-Type: application/json" -d "{ "some rubbish" }"``` |
| `Error while reading secret from file` | Unable to read the secret key (password) from file specified by TESSERA*CONFIG_SECRET<br />**Action**: \_ensure the secret key file configuration is correct, and file can be read* |
| `unable to initialize encryption façade {error details}` | Unable to initialize elliptical curve encryption. Logged error message will give further details<br />**Action**: _check configuration properties_ |
| `unable to generate shared secret {error details}` | Unable to generate shared secret for elliptical curve encryption. Logged error message will give further details. <br />**Action**: _check configuration properties_ |
| `unable to perform symmetric encryption {error details}` | Unable to encrypt data. Logged error message will give further details.<br />**Action**: _check configuration properties_ |
| `unable to perform symmetric decryption {error details}` | Unable to decrypt data. Logged error message will give further details.<br />**Action**: _check configuration properties_ |
| `Error when executing action {action type}, exception details: {error details}` | Unable to start Influx DB. Logged error message will give further details<br />**Action**: _check configuration properties_ |
| `Error creating bean with name 'entityManagerFactory'` | | Unable to create connection to database due to failure to decrypt the DB password using the supplied secret key<br />**Action**: _ensure that the correct value is supplied for the secret key_ |
| `Error creating bean with name 'entityManagerFactory'` | Unable to create connection to database due to failure to decrypt the DB password using the supplied secret key<br />**Action**: _ensure that the correct value is supplied for the secret key_ |
| `Config validation issue: {property name} {error details}` | Invalid configuration detected<br />**Action**: _correct the configuration of the named property._ |
| `Invalid json, cause is {error details}` | Invalid JSON in the configuration file<br />**Action**: _check the configuration file for mistakes._ |
| `Configuration exception, cause is {error details}` | Invalid data in the configuration file<br />**Action**: _check the configuration file for mistakes._ |
Expand Down
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
const lightCodeTheme = require("prism-react-renderer").themes.github;
const darkCodeTheme = require("prism-react-renderer").themes.dracula;

/** @type {import('@docusaurus/types').Config} */
const config = {
Expand Down
Loading

0 comments on commit f4298df

Please sign in to comment.