Skip to content

Latest commit

 

History

History
59 lines (33 loc) · 2.49 KB

README.md

File metadata and controls

59 lines (33 loc) · 2.49 KB
Raw

Wildfly.org Website Based on Jekyll

Getting Started

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

Installation

Jekyll static site generator documentation.

  1. Install a full Ruby development environment.

  2. Install Bundler:

     gem install bundler

  3. Fork the project repository, then clone your fork:

     git clone [email protected]:YOUR_USER_NAME/wildfly.org.git

  4. Change into the project directory:

     cd wildfly.org

  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:

     bundle exec jekyll serve

  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.

Writing a News post

To write a News post:

  • If you are a new author, create an author entry in _data/authors.yaml
  • Create an news entry under _posts
    • The file name is yyyy-mm-dd-slug.adoc
  • All news posts should be written in AsciiDoc format.
  • Create a pull request against the master branch.

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.

Important: the guides are maintained in the wildfly.github.io repository and pull requests should be submitted there: https://github.com/wildfly/wildfly.github.io

License

This website is licensed under the Creative Commons Attribution 3.0.