Skip to content

Commit 7fecb62

Browse files
committed
Update README including new website references
Signed-off-by: Andrea Lamparelli <a.lamparelli95@gmail.com>
1 parent 794f9f6 commit 7fecb62

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,35 @@
22
---
33
# Hyperfoil.io Website Based on Jekyll
44

5-
## Getting Started
5+
>[!NOTE]
6+
> The content of this `master` branch is old, :point_right: checkout [Hyperfoil](https://github.com/Hyperfoil/Hyperfoil/tree/master/docs) repository for the website source code or the [gh-pages](https://github.com/Hyperfoil/hyperfoil.github.io/tree/gh-pages) branch of this repository for the live content published at [hyperfoil.io](https://hyperfoil.io).
7+
8+
## New website
9+
10+
Starting from July 15th, we published a renewed version of the Hyperfoil website.
11+
12+
With this renewal we changed some things that are summarized below:
13+
- The source code of the website has been move in the [Hyperfoil](https://github.com/Hyperfoil/Hyperfoil/tree/master/docs) repository, this way docs changes can be done in the same pull request of the feature change.
14+
- The website is entirely based on [docsy](https://www.docsy.dev/) Hugo template, therefore we switched to [Hugo](https://gohugo.io/) as static site generator.
15+
- The live content is hosted in the [gh-pages](https://github.com/Hyperfoil/hyperfoil.github.io/tree/gh-pages) branch of this repository, we will empty the `master` one in the coming future.
16+
- The website deployment is automated using a GitHub worklofow, see [deploy-gh-pages.yaml](./.github/workflows/deploy-gh-pages.yaml) for more details.
17+
- The live content points to the latest *stable* branch in the Hyperfoil repository, e.g., `0.26.x`. You can find the used branch in the [deploy-gh-pages.yaml](https://github.com/lampajr/hyperfoil.github.io/blob/355ed02d88f3247e946b975b8235ad7be2fdd6fb/.github/workflows/deploy-gh-pages.yaml#L30) configuration.
18+
19+
20+
For more information on how to build (locally) and update the website content, please checkout [github.com/Hyperfoil/Hyperfoil/docs](https://github.com/Hyperfoil/Hyperfoil/tree/master/docs).
21+
22+
## Old website
23+
24+
>[!NOTE]
25+
> This content will be removed in the coming future!
26+
27+
The `master` branch contains the content for the old Jekyll-based static website that is no longer published anywhere.
28+
29+
### Getting Started
630

731
These instructions will get you a copy of the Hyperfoil.io website up and running on your local machine for development and testing purposes.
832

9-
### Installation
33+
#### Installation
1034
[Jekyll static site generator docs](https://jekyllrb.com/docs/).
1135

1236
1. Install a full [Ruby development environment](https://jekyllrb.com/docs/installation/)

0 commit comments

Comments
 (0)