• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

quarkusio/quarkusio.github.io: Website for Quarkus project

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称(OpenSource Name):

quarkusio/quarkusio.github.io

开源软件地址(OpenSource Url):

https://github.com/quarkusio/quarkusio.github.io

开源编程语言(OpenSource Language):

HTML 90.1%

开源软件介绍(OpenSource Introduction):

Quarkus.io Website Based on Jekyll

Getting Started

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

Installation

Jekyll static site generator docs.

  1. Install a full Ruby development environment. If you use rvm, run: rvm use 2.7.1.

  2. Install bundler gems

     gem install bundler
    
  3. Fork the project repository, then clone your fork.

     git clone [email protected]:YOUR_USER_NAME/quarkusio.github.io.git
    
  4. Change into the project directory:

     cd quarkusio.github.io
    
  5. Use bundler to fetch all required gems in their respective versions

     bundle install
    
  6. Build the site and make it available on a local server

     ./serve.sh
    

    Or if you want it faster and okey to not have guides included use the following:

     ./serve-noguides.sh
    
  7. Now browse to http://localhost:4000

If you encounter any unexpected errors during the above, please refer to the troubleshooting page or the requirements page, as you might be missing development headers or other prerequisites.

For more regarding the use of Jekyll, please refer to the Jekyll Step by Step Tutorial.

Deploying to GitHub Pages

The website deployment is automatically performed by GitHub Actions (when commits are pushed to the develop branch). If for some reason you need to deploy from your local machine, follow these instructions:

  1. Install the act executable to run GitHub Actions locally
  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.

Writing a blog

To write a blog:

  • create an author entry in _data/authors.yaml

  • create an blog entry under _posts

    • the file name is yyyy-mm-dd-slug.adoc
  • tags should be used with some care as an archive page is created for of them. Below are some basic rules to try follow:

    • quarkus-release used for Quarkus release blogs
    • announcement used for general announcement with some impact.
    • extension used for blogs related to a specific extension.
    • user-story used for stories from users/companies adopting Quarkus.
    • development-tips used for blogs with tips to develop using Quarkus or Quarkus itself.
    • add a tech specific, like kafka, if your post has a significant mention/relevance to that technology.
    • tags is space separated list tags:extension grpc
    • tags must be in lowercase
  • it's in asciidoc format, there is an example as shown with 2019-06-05-quarkus-and-web-ui-development-mode.adoc

    • Be aware that the date attribute in the asciidoc preamble defines when the article will be published. Use a present date while writing your article to test locally, then switch to the actual target date before submitting.
  • send a pull request against the develop branch and voilà

Translations/Localization (l10n)

The primary site (quarkus.io) is written in English.

There are separate repositories for community driven localized versions of quarkus.io:

If you want to contribute to those efforts read the README in those projects. If you would like to start another translation, please open an issue in this main repo.

Enable DNS for l10n site

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 a ticket to IT asking for XX domain:

We need a CNAME record set up for XX.quarkus.io to have it serve out GitHub pages. 

The CNAME record for XX.quarkus.io should point to "quarkusio.github.io.".

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.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Important: 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.

License

This website is licensed under the Creative Commons Attribution 3.0.




鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap