Skip to content

Commit 57df67f

Browse files
authored
Small Changes (#2543)
1 parent ee9a5e3 commit 57df67f

2 files changed

Lines changed: 56 additions & 45 deletions

File tree

README.md

Lines changed: 55 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -10,67 +10,78 @@ These instructions will get you a copy of the Quarkus.io website up and running
1010

1111
1. Install [Docker Desktop](https://docs.docker.com/install/) or [Podman Desktop](https://podman-desktop.io/)
1212
2. Fork the [project repository](https://github.com/quarkusio/quarkusio.github.io), then clone your fork:
13-
14-
git clone git@github.com:YOUR_USER_NAME/quarkusio.github.io.git
15-
13+
```sh
14+
git clone git@github.com:YOUR_USER_NAME/quarkusio.github.io.git
15+
```
1616
3. Change into the project directory:
17-
18-
cd quarkusio.github.io
19-
20-
4. Run Docker Compose or Podman Compose:
21-
22-
docker compose up
23-
24-
or
25-
26-
podman compose up
27-
28-
By default, this does not include guides. To include guides, use `podman compose --file docker-compose_with_guides.yml up`. If the guides build terminates abruptly before completion, make sure your [container engine has enough memory allocated](https://podman-desktop.io/docs/podman/creating-a-podman-machine#procedure) (it will need at least 5GB).
29-
30-
> **Note:** The startup process may take several minutes, depending on your system. During this time, you might see logs with warnings or configuration messages (e.g., AutoPages and asciidoctor warnings). This is normal behavior as Jekyll builds the site. Once the server is running, you will see output like this:
31-
17+
```sh
18+
cd quarkusio.github.io
3219
```
33-
jekyll-1 | Server address: http://0.0.0.0:4000/
34-
jekyll-1 | Server running... press ctrl-c to stop.
20+
4. Run Docker Compose or Podman Compose:
21+
```sh
22+
docker compose up
3523
```
24+
or
3625

37-
If any error occurs mentioning a name conflict, try:
26+
```sh
27+
podman compose up
28+
```
3829

39-
docker compose up --force-recreate
30+
By default, this does not include guides. To include guides, use:
31+
```sh
32+
docker compose --file docker-compose_with_guides.yml up
33+
```
34+
If the guides build terminates abruptly before completion, make sure your [container engine has enough memory allocated](https://podman-desktop.io/docs/podman/creating-a-podman-machine#procedure) (it will need at least 5GB).
35+
36+
> [!NOTE]
37+
> The startup process may take several minutes, depending on your system. During this time, you might see logs with warnings or configuration messages (e.g., AutoPages and asciidoctor warnings). This is normal behavior as Jekyll builds the site. Once the server is running, you will see output like this:
38+
>
39+
> ```
40+
> jekyll-1 | Server address: http://0.0.0.0:4000/
41+
> jekyll-1 | Server running... press ctrl-c to stop.
42+
> ```
43+
44+
If an error occurs mentioning a name conflict, try:
45+
```sh
46+
docker compose up --force-recreate
47+
```
4048

4149
5. Now browse to [http://localhost:4000](http://localhost:4000).
4250
#### Using a local Ruby environment
4351
[Jekyll static site generator docs](https://jekyllrb.com/docs/).
4452

4553
1. Install a full [Ruby development environment](https://jekyllrb.com/docs/installation/). If you use `rvm`, run: `rvm use 3.2.3`.
4654
2. Install [bundler](https://jekyllrb.com/docs/ruby-101/#bundler) [gems](https://jekyllrb.com/docs/ruby-101/#gems)
47-
48-
gem install bundler
49-
55+
```sh
56+
gem install bundler
57+
```
5058
3. Fork the [project repository](https://github.com/quarkusio/quarkusio.github.io), then clone your fork.
51-
52-
git clone git@github.com:YOUR_USER_NAME/quarkusio.github.io.git
53-
59+
```sh
60+
git clone git@github.com:YOUR_USER_NAME/quarkusio.github.io.git
61+
```
5462
4. Change into the project directory:
55-
56-
cd quarkusio.github.io
57-
63+
```sh
64+
cd quarkusio.github.io
65+
```
5866
5. Use bundler to fetch all required gems in their respective versions
59-
60-
bundle install
61-
67+
```sh
68+
bundle install
69+
```
6270
6. Build the site and make it available on a local server
63-
64-
./serve.sh
65-
71+
```sh
72+
./serve.sh
73+
```
6674
Or if you want it faster and okay to not have guides included use the following:
6775

68-
./serve-noguides.sh
76+
```sh
77+
./serve-noguides.sh
78+
```
6979

7080

7181
7. Now browse to http://localhost:4000
7282

73-
> If you encounter any unexpected errors during the above, please refer to the [troubleshooting](https://jekyllrb.com/docs/troubleshooting/#configuration-problems) page or the [requirements](https://jekyllrb.com/docs/installation/#requirements) page, as you might be missing development headers or other prerequisites.
83+
>[!NOTE]
84+
>If you encounter any unexpected errors during the above, please refer to the [troubleshooting](https://jekyllrb.com/docs/troubleshooting/#configuration-problems) page or the [requirements](https://jekyllrb.com/docs/installation/#requirements) page, as you might be missing development headers or other prerequisites.
7485

7586
**For more regarding the use of Jekyll, please refer to the [Jekyll Step by Step Tutorial](https://jekyllrb.com/docs/step-by-step/01-setup/).**
7687

@@ -84,9 +95,9 @@ If for some reason you need to deploy from your local machine, follow these inst
8495

8596
## Writing a blog
8697

87-
> **NOTE:** Using generative AI in *assisting* writing is fine, but please don't use it to write entire posts.
88-
> Used badly, generative AI has a tendency to use complex words and phrasing. This makes
89-
the content hard to read and understand. Always review your blog with a human reader in mind, make sure it's factually correct and especially keep the human touch and opinions in the content.
98+
> [!WARNING]
99+
> Using generative AI in *assisting* writing is fine, but please don't use it to write entire posts.
100+
> Used badly, generative AI has a tendency to use complex words and phrasing. This makes the content hard to read and understand. Always review your blog with a human reader in mind, make sure it's factually correct and especially keep the human touch and opinions in the content.
90101

91102
To write a blog:
92103

@@ -141,8 +152,8 @@ See Step 5 on https://docs.github.com/en/github/working-with-github-pages/managi
141152
142153
Please read [CONTRIBUTING.md](https://github.com/quarkusio/quarkusio.github.io/tree/main/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
143154
144-
**Important:** the guides are maintained in the main Quarkus repository and pull requests should be submitted there:
145-
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc.
155+
> [!IMPORTANT]
156+
> The guides are maintained in the main Quarkus repository and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc.
146157
147158
## License
148159

_includes/CF-footerband.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<a class="cf-logo" href="https://www.commonhaus.org/" target="_blank"><img src="https://raw.githubusercontent.com/commonhaus/artwork/main/foundation/brand/svg/CF_logo_horizontal_single_reverse.svg"/></a>
55
</div>
66
<div class="license">
7-
Copyright © Quarkus. All rights reserved. For details on our trademarks, please visit our <a href="https://www.commonhaus.org/policies/trademark-policy/">Trademark Policy</a> and <a href="https://www.commonhaus.org/trademarks/">Trademark List</a>. Trademarks of third parties are owned by their respective holders and their mention here does not suggest any endorsement or association.
7+
Copyright © <a href="/">Quarkus</a>. All rights reserved. For details on our trademarks, please visit our <a href="https://www.commonhaus.org/policies/trademark-policy/">Trademark Policy</a> and <a href="https://www.commonhaus.org/trademarks/">Trademark List</a>. Trademarks of third parties are owned by their respective holders and their mention here does not suggest any endorsement or association.
88
</div>
99
</div>
1010
</div>

0 commit comments

Comments
 (0)