Skip to content

Commit

Permalink
update yarn.lock
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 Dec 20, 2023
1 parent 88e8190 commit db756ec
Show file tree
Hide file tree
Showing 4 changed files with 2,711 additions and 32,004 deletions.
30 changes: 3 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,34 +9,10 @@ The doc site is hosted at [`besu.hyperledger.org`](https://besu.hyperledger.org)

If you're looking for the software source code, go to the [Besu software repository](https://github.com/hyperledger/besu).

## Versions of docs and how to host previous versions

At present, we tag every version (including patch) in the repository but we only display [three versions of the docs for the most recent minor versions](https://discord.com/channels/905194001349627914/905205502940696607/1179912405216669828) in the `versioned_docs` folder. eg: `23.10.2, 23.7.3 and 23.4.1` In addition we also maintain the in flight `development` version in the `docs` folder.

In order to build or host a specific version eg `23.7.1`
1. Clone this repo and checkout the tag
```
git@github.com:hyperledger/besu-docs.git
git checkout 23.7.1
```

2. Build and run locally
```
yarn
yarn run start
```
Open up a browser tab and navigate to `http://localhost:3000/development`

3. (Optional) host this version on your own infrastructure (eg: nginx, s3 etc)
```
yarn
yarn run build
# optional - this is to check the output locally
yarn run serve
```
Host the contents of the `build` folder on your own infrastructure
### Viewing older versions of docs

See the [versions section in the Hyperledger Besu wiki](https://wiki.hyperledger.org/display/BESU/Versions+of+docs+and+how+to+host+previous+versions)
for information about viewing and hosting older versions of the documentation on your own infrastructure

### Contribute to the docs

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ const config = {
},
"23.4.1": {
label: "23.4.1",
}
},
},
routeBasePath: "/",
// @ts-ignore
Expand Down
Loading

0 comments on commit db756ec

Please sign in to comment.