Creating a Groovy Blog Post

If you are already familiar with git, first fork the repo using the WebUI. Then clone the repo on the commandline in the normal way:

Or if you have the GitHub CLI tools installed, you can fork and clone in one step using:

Now create a new .adoc file in the site/src/site/blog/ directory. You can edit the file using your favourite text/Asciidoc editor or an IDE. I generally use Intellij IDEA with the Asciidoc plugin.

You’ll want to follow all the normal steps to create a pull request on GitHub. This will typically involve creating a branch, committing your new file (and maybe images), pushing your branch to your fork, and then creating the actual PR.

If you don’t want to install git and an editor/IDE, you can use the WebUI. Simply navigate to the repo, go to the site/src/site/blog/ folder, then under Add file click on Create new file. It should look something like the following image:

You will be prompted to enter an appropriate name for your file:

You generally pick a unique name that isn’t too long. Here we picked create-groovy-blog.adoc. Don’t get too stressed out about the name, we can provide further guidance once your PR is submitted if your name seems out-of-place compared to existing names. We generally avoid using exotic characters like emojis in the filenames. Some of the tooling doesn’t like such characters.

We now enter Asciidoc content into the file:

The first line is the title for the post. The second line is the author (or authors). The next few lines contain metadata. Your best bet is to copy the metadata from an existing post and change accordingly, but we’ll guide you through any changes if needed once the PR is submitted.

When finished, click on "Commit changes…​":

If you haven’t forked the repository before, you might be prompted to do that now:

Next, you have the option to override the default commit message and provide an optional extended description if you wish:

When ready, click "Propose changes".

You should now see a summary of your pull request.

Add a comment if you wish and finally click "Create pull request".

Your PR should now be listed under the repo’s pull requests:

https://github.com/apache/groovy-website/pulls

As mentioned earlier, we welcome a wide range of topics for the posts. Not every topic may be suitable. We need to make sure anything we post conforms with normal copyright restrictions and can be released under the Apache license. Also, we generally don’t want duplicated content or content which is overtly commercial in nature.

If in doubt, it might be good to have a short conversation with the Apache Groovy team on the mailing list or Slack channel before you create your PR. Further details about contacting the team are on the getting involved page.

If your post takes inspiration from other sites or content, make sure to provide appropriate attribution. Finally, make sure you have some fun writing the post. It will be more enjoyable for you and our readers!

The acceptance process might involve several iterations to improve the content.

Your PR, once accepted, will be merged into the repo. At this point, a CI job kicks off and will build a new version of the website. You can watch the CI progress here:

https://ci-builds.apache.org/job/Groovy/job/Groovy%20dev%20website/

And the end result will appear here:

https://groovy.apache.org/blog