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:
  • If you wish to have a picture associated with your posts, please add a file to the authors subdir in the assets directory. This is optional, but encouraged.
  • Create an author entry in _data/authors.yaml
    • If you added an author photo, include the avatar field with a value that is the name of the author's picture file in authors subdir in the assets directory.
• 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.

Adding Signing Information

To create information about your public keys used to sign commits and files, you need to update the contributors.yaml file with some information about your public keys. In the examples below we will use GnuPG Privacy Guard.

Generating your key and uploading your key to a remote server is beyond the scope of these instructions.

Finding your key

gpg --list-key --keyid-format short

This will list your available keys.

/home/user/.gnupg/pubring.kbx
---------------------------------
pub   rsa4096/39B3A8E7 2021-02-16 [SC]
      6D2AF456B8CB597387901C786F29F72839B3A8E7
uid         [ultimate] James R. Perkins <[email protected]>
sub   rsa4096/382337E8 2021-02-16 [E]

You will also need your fingerprint which can be retrieved with:

gpg --list-key --fingerprint

This produces:

pub   rsa4096 2021-02-16 [SC]
      6D2A F456 B8CB 5973 8790  1C78 6F29 F728 39B3 A8E7
uid           [ultimate] James R. Perkins <[email protected]>
sub   rsa4096 2021-02-16 [E]

Adding your information

Below is the example YAML you would add to the contributors.yaml file associated with your bio.

- contributor: jperkins
  name: "James R. Perkins"
  bio: "Example bio"
  github: jamezp
  signing:
    - pgp:
        id: rsa4096/39B3A8E7
        key: 6D2AF456B8CB597387901C786F29F72839B3A8E7
        link: https://keyserver.ubuntu.com/pks/lookup?search=6D2AF456B8CB597387901C786F29F72839B3A8E7&fingerprint=on&op=index
        fingerprint: 6D2A F456 B8CB 5973 8790  1C78 6F29 F728 39B3 A8E7

Contributing

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

Important: Code examples referred to in the guides are maintained in the wildfly-extras/guides repository and pull requests should be submitted there.

License

This website is licensed under the Creative Commons Attribution 3.0 license.