Skip to content

Commit f3fe68e

Browse files
committed
Update GitHub Pages
1 parent 0153f06 commit f3fe68e

File tree

6,380 files changed

+4491903
-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,380 files changed

+4491903
-0
lines changed

docs/.well-known/atproto-did

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
did:plc:a3ckxd7pwewp7dn555oskvqe

docs/1000contributors/index.html

Lines changed: 11622 additions & 0 deletions
Large diffs are not rendered by default.

docs/404.html

Lines changed: 400 additions & 0 deletions
Large diffs are not rendered by default.

docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ja.quarkus.io

docs/CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
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

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

0 commit comments

Comments
 (0)