Skip to content

Commit

Permalink
notice about using generative AI for blogs (#2112)
Browse files Browse the repository at this point in the history
* notice about using generative AI for blogs

* Update README.md

Co-authored-by: Holly Cummins <[email protected]>

---------

Co-authored-by: Holly Cummins <[email protected]>
  • Loading branch information
maxandersen and holly-cummins authored Sep 9, 2024
1 parent c68a0ba commit cc1a0c6
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ If for some reason you need to deploy from your local machine, follow these inst

## Writing a blog

> **NOTE:** Using generative AI in *assisting* writing is fine, but please don't use it to write entire posts.
> Used badly, generative AI has a tendency to use complex words and phrasing. This makes
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.

To write a blog:

- create an author entry in [_data/authors.yaml](https://github.com/quarkusio/quarkusio.github.io/blob/main/_data/authors.yaml)
Expand All @@ -90,6 +94,8 @@ To write a blog:
- 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.
- send a pull request against the main branch and voilà



## Translations/Localization (l10n)

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

0 comments on commit cc1a0c6

Please sign in to comment.