Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

notice about using generative AI for blogs #2112

Merged
merged 2 commits into from
Sep 9, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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's has a tendency to use complex works and phrasing making
maxandersen marked this conversation as resolved.
Show resolved Hide resolved
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