Skip to content

Commit c3c1460

Browse files
committed
Update GitHub Pages
1 parent b6552b4 commit c3c1460

File tree

6,544 files changed

+4561148
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

6,544 files changed

+4561148
-0
lines changed

docs/.well-known/atproto-did

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
did:plc:a3ckxd7pwewp7dn555oskvqe

docs/1000contributors/index.html

+11,625
Large diffs are not rendered by default.

docs/404.html

+403
Large diffs are not rendered by default.

docs/CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ja.quarkus.io

docs/CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Contributing to the Quarkus.io website
2+
3+
Contributions are welcome, please submit pull requests for the `main` branch.
4+
5+
**Important:** the guides are maintained in the main Quarkus repository and pull requests should be submitted there:
6+
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc.

docs/README.md

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Quarkus.io Website Based on Jekyll
2+
3+
## はじめに
4+
5+
These instructions will get you a copy of the Quarkus.io website up and running on your local machine for development and testing purposes.
6+
7+
### インストール
8+
9+
#### Dockerの使用
10+
11+
1. Install [Docker Desktop](https://docs.docker.com/install/).
12+
13+
2. Fork the [project repository](https://github.com/quarkusio/quarkusio.github.io), then clone your fork:
14+
15+
16+
git clone git@github.com:YOUR_USER_NAME/quarkusio.github.io.git
17+
18+
3. Change into the project directory:
19+
20+
21+
cd quarkusio.github.io
22+
23+
4. Run Docker Compose:
24+
25+
26+
docker compose up
27+
28+
> **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:
29+
30+
```
31+
jekyll-1 | Server address: http://0.0.0.0:4000/
32+
jekyll-1 | Server running... press ctrl-c to stop.
33+
```
34+
35+
If any error occurs mentioning a name conflict, try:
36+
37+
docker compose up --force-recreate
38+
39+
5. Now browse to [http://localhost:4000](http://localhost:4000).
40+
41+
#### Using a local Ruby environment
42+
[Jekyll static site generator docs](https://jekyllrb.com/docs/).
43+
44+
1. Install a full [Ruby development environment](https://jekyllrb.com/docs/installation/). If you use `rvm`, run: `rvm use 3.2.3`.
45+
46+
2. Install [bundler](https://jekyllrb.com/docs/ruby-101/#bundler) [gems](https://jekyllrb.com/docs/ruby-101/#gems)
47+
48+
49+
gem install bundler
50+
51+
3. Fork the [project repository](https://github.com/quarkusio/quarkusio.github.io), then clone your fork.
52+
53+
54+
git clone git@github.com:YOUR_USER_NAME/quarkusio.github.io.git
55+
56+
4. Change into the project directory:
57+
58+
59+
cd quarkusio.github.io
60+
61+
5. Use bundler to fetch all required gems in their respective versions
62+
63+
64+
bundle install
65+
66+
6. Build the site and make it available on a local server
67+
68+
69+
./serve.sh
70+
71+
Or if you want it faster and okay to not have guides included use the following:
72+
73+
./serve-noguides.sh
74+
75+
76+
7. Now browse to http://localhost:4000
77+
78+
79+
> 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.
80+
81+
**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/).**
82+
83+
### Deploying to GitHub Pages
84+
85+
The website deployment is automatically performed by GitHub Actions (when commits are pushed to the `main` branch).
86+
If for some reason you need to deploy from your local machine, follow these instructions:
87+
88+
1. Install the [act](https://github.com/nektos/act#installation) executable to run GitHub Actions locally
89+
90+
2. Run `act -s GITHUB_TOKEN=<GITHUB_TOKEN>`, where *<GITHUB_TOKEN>* needs to be replaced with a token that allows you to push to the https://github.com/quarkusio/quarkusio.github.io repository.
91+
92+
93+
## Writing a blog
94+
95+
> **NOTE:** Using generative AI in *assisting* writing is fine, but please don't use it to write entire posts.
96+
> Used badly, generative AI has a tendency to use complex words and phrasing. This makes
97+
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+
99+
To write a blog:
100+
101+
- create an author entry in [_data/authors.yaml](https://github.com/quarkusio/quarkusio.github.io/blob/main/_data/authors.yaml)
102+
103+
- `emailhash` you can get by running `echo -n your@email.org | md5sum` on Linux or `echo -n your@email.org | md5` on macOS using an email you have registered from the [Gravatar service](https://gravatar.com),
104+
105+
106+
- create an blog entry under [_posts](https://github.com/quarkusio/quarkusio.github.io/tree/main/_posts)
107+
108+
- the file name is `yyyy-mm-dd-slug.adoc` Set the date to the same value in the asciidoc preamble.
109+
110+
- `tags` should be used with some care as an archive page is created for of them. Below are some basic rules to try follow:
111+
112+
- `quarkus-release` used for Quarkus release blogs
113+
114+
- `announcement` used for general announcement with some impact.
115+
116+
- `extension` used for blogs related to a specific extension.
117+
118+
- `user-story` used for stories from users/companies adopting Quarkus.
119+
120+
- `development-tips` used for blogs with tips to develop using Quarkus or Quarkus itself.
121+
122+
- add a tech specific, like `kafka`, if your post has a significant mention/relevance to that technology.
123+
124+
- tags is space separated list `tags:extension grpc`
125+
126+
- tags must be in lowercase
127+
128+
- it's in asciidoc format, there is an example as shown with [2019-06-05-quarkus-and-web-ui-development-mode.adoc](https://github.com/quarkusio/quarkusio.github.io/blob/main/_posts/2019-06-05-quarkus-and-web-ui-development-mode.adoc)
129+
130+
- Be aware that the `date` attribute in the asciidoc preamble defines when the article will be published. Add a `--future` flag when testing locally to ensure the article is included in the generated site.
131+
132+
- send a pull request against the main branch and voilà
133+
134+
135+
136+
137+
## Translations/Localization (l10n)
138+
139+
The primary site (quarkus.io) is written in English.
140+
141+
There are separate repositories for community driven localized versions of quarkus.io:
142+
143+
- [ja.quarkus.io](https://github.com/quarkusio/ja.quarkus.io) for Japanese
144+
145+
- [cn.quarkus.io](https://github.com/quarkusio/cn.quarkus.io) for Chinese (simplified)
146+
147+
- [es.quarkus.io](https://github.com/quarkusio/es.quarkus.io) for Spanish
148+
149+
- [pt.quarkus.io](https://github.com/quarkusio/pt.quarkus.io) for Brazilian Portuguese
150+
151+
152+
If you want to contribute to those efforts read the README in those projects. If you would like to
153+
start another translation, please open an issue in this main repo.
154+
155+
#### Enable DNS for l10n site
156+
157+
Once a localized site has enough of its content translated, DNS needs to be enabled. To do that get one of the Red Hat admins to submit
158+
a ticket to IT asking for XX domain:
159+
160+
```
161+
We need a CNAME record set up for XX.quarkus.io to have it serve out GitHub pages.
162+
163+
The CNAME record for XX.quarkus.io should point to "quarkusio.github.io.".
164+
```
165+
166+
See Step 5 on https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site for more information.
167+
168+
## 貢献
169+
170+
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.
171+
172+
**Important:** the guides are maintained in the main Quarkus repository and pull requests should be submitted there:
173+
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc.
174+
175+
## ライセンス
176+
177+
This website is licensed under the [Creative Commons Attribution 3.0](https://creativecommons.org/licenses/by/3.0/).

0 commit comments

Comments
 (0)