Skip to content

Commit

Permalink
add in lint plugins
Browse files Browse the repository at this point in the history
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
  • Loading branch information
joshuafernandes committed Sep 19, 2024
1 parent c859c94 commit 892d336
Show file tree
Hide file tree
Showing 8 changed files with 214 additions and 35 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build and lint
name: Build

on:
workflow_call:
Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Check for link errors

on:
workflow_call:

jobs:
linkCheck:
name: Link Checking
runs-on: ubuntu-latest
strategy:
matrix:
file-extensions: [".md", ".mdx"]
steps:
- uses: actions/checkout@v4
- name: LinkCheck
uses: ConsenSys/docs-gha/linkcheck@main
with:
FILE_EXTENSION: ${{ matrix.file-extensions }}
19 changes: 2 additions & 17 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Check for lint, spelling and link errors
name: Check for lint errors

on:
workflow_call:

jobs:
lint:
name: Lint Code Base, Spelling, Link Check
name: Lint Code Base
runs-on: ubuntu-latest
permissions:
contents: read
Expand All @@ -15,18 +15,3 @@ jobs:

- name: Lint
uses: ConsenSys/docs-gha/lint@main
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

linkCheck:
name: Link Checking
runs-on: ubuntu-latest
strategy:
matrix:
file-extensions: [".md", ".mdx"]
steps:
- uses: actions/checkout@v4
- name: LinkCheck
uses: ConsenSys/docs-gha/linkcheck@main
with:
FILE_EXTENSION: ${{ matrix.file-extensions }}
1 change: 1 addition & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ jobs:
- check-workflows
- build
- lint
- links
outputs:
PASSED: ${{ steps.set-output.outputs.PASSED }}
steps:
Expand Down
168 changes: 168 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@
"devDependencies": {
"@commitlint/cli": "^18.2.0",
"@commitlint/config-conventional": "^18.1.0",
"@docusaurus/eslint-plugin": "^3.5.2",
"@docusaurus/module-type-aliases": "^3.5.2",
"@docusaurus/tsconfig": "^3.5.2",
"@docusaurus/types": "^3.5.2",
"@semantic-release/changelog": "^6.0.3",
"@semantic-release/commit-analyzer": "^10.0.4",
"@semantic-release/git": "^10.0.1",
Expand Down
5 changes: 3 additions & 2 deletions src/components/HomepageCards/index.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from "react";
import clsx from "clsx";
import Link from "@docusaurus/Link";
import Heading from '@theme/Heading'
// import styles from "./styles.module.css";

type CardItem = {
Expand Down Expand Up @@ -51,7 +52,7 @@ function Card({ title, link, description, buttonName, buttonType }: CardItem) {
<div className="card-demo">
<div className="card">
<div className="card__header">
<h3>{title}</h3>
<Heading as='h3'>{title}</Heading>
</div>
<div className="card__body">
<p>{description}</p>
Expand All @@ -77,7 +78,7 @@ export default function HomepageCards(): JSX.Element {
return (
<section className={clsx("margin-top--lg", "margin-bottom--lg")}>
<div className="container homepageContainer">
<h1 className="homepageTitle">Hyperledger Besu Ethereum client</h1>
<Heading as='h1' className="homepageTitle">Hyperledger Besu Ethereum client</Heading>
<p>
Hyperledger Besu is an open source Ethereum client developed under the
Apache 2.0 license and written in Java. It runs on public and private
Expand Down
32 changes: 17 additions & 15 deletions src/pages/index.tsx
Original file line number Diff line number Diff line change
@@ -1,52 +1,54 @@
import React from "react";
import Layout from "@theme/Layout";
import Link from "@docusaurus/Link";
import Heading from '@theme/Heading'
import HomepageCards from "@site/src/components/HomepageCards";

function HomepageText() {
return (
<div className="container homepageContainer margin-bottom--xl">
<h2>What does Besu support?</h2>
<Heading as='h2'>What does Besu support?</Heading>
<p>
Besu includes a{" "}
<a href="/public-networks/reference/cli/options">
<Link href="/public-networks/reference/cli/options">
command line interface
</a>{" "}
and <a href="/public-networks/how-to/use-besu-api">JSON-RPC API</a> for
</Link>{" "}
and <Link to="/public-networks/how-to/use-besu-api">JSON-RPC API</Link> for
running, maintaining, debugging, and monitoring nodes in an Ethereum
network. You can use the API via RPC over HTTP or via WebSocket. Besu
also supports Pub/Sub.
</p>
<p>
Besu supports common smart contract and dapp development, deployment,
and operational use cases, using tools such as{" "}
<a href="https://github.com/NomicFoundation/hardhat">Hardhat</a>,{" "}
<a href="https://github.com/ethereum/remix">Remix</a>, and{" "}
<a href="https://web3j.io/">web3j</a>. The client supports common
<Link to="https://github.com/NomicFoundation/hardhat">Hardhat</Link>,{" "}
<Link to="https://github.com/ethereum/remix">Remix</Link>, and{" "}
<Link to="https://web3j.io/">web3j</Link>. The client supports common
JSON-RPC API methods such as <code>eth</code>, <code>net</code>,{" "}
<code>web3</code>, <code>debug</code>, and <code>miner</code>.
</p>
<p>
Besu doesn&apos;t support key management inside the client. You can use{" "}
<a href="https://docs.web3signer.consensys.net/">Web3Signer</a> with
<Link to="https://docs.web3signer.consensys.net/">Web3Signer</Link> with
Besu to access your keystore and sign transactions.
</p>

<h2>Questions?</h2>
<Heading as='h2'>Questions?</Heading>
<p>
If you have any questions about Besu, ask on the <b>besu</b> channel on{" "}
<a href="https://discord.gg/hyperledger">Hyperledger Discord</a>.
<Link to="https://discord.gg/hyperledger">Hyperledger Discord</Link>.
</p>
<p>
Learn more about the{" "}
<a href="https://www.hyperledger.org/about">Hyperledger Foundation</a>.
<Link to="https://www.hyperledger.org/Linkbout">Hyperledger Foundation</Link>.
You can{" "}
<a href="https://wiki.hyperledger.org/display/BESU/Documentation">
<Link to="https://wiki.hyperledger.org/display/BESU/Documentation">
contribute to the documentation
</a>{" "}
</Link>{" "}
or to{" "}
<a href="https://wiki.hyperledger.org/display/BESU/Contributing">
<Link to="https://wiki.hyperledger.org/display/BESU/Contributing">
Besu itself
</a>
</Link>
.
</p>
</div>
Expand Down

0 comments on commit 892d336

Please sign in to comment.