Skip to content
Open
Changes from all commits
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
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,33 +32,33 @@ Table end

Installation
----------------------
Choose either the CentOS Stream 9 or RHEL8 based image:
Choose either the CentOS Stream 10 or RHEL10 based image:

* **RHEL8 based image**
* **RHEL10 based image**
Comment on lines +35 to +37
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Use standard product naming/hyphenation for readability and consistency.

RHEL10 based should be written as RHEL 10-based (same pattern for similar phrases). This improves doc clarity and resolves the grammar warnings.

Suggested doc tweak
-Choose either the CentOS Stream 10 or RHEL10 based image:
+Choose either the CentOS Stream 10-based or RHEL 10-based image:

-*  **RHEL10 based image**
+*  **RHEL 10-based image**

-    To build a RHEL10 based Nginx image, you need to run Docker build on a properly
+    To build a RHEL 10-based Nginx image, you need to run Docker build on a properly

Also applies to: 46-46

🧰 Tools
🪛 LanguageTool

[grammar] ~35-~35: Use a hyphen to join words.
Context: ...- Choose either the CentOS Stream 10 or RHEL10 based image: * RHEL10 based image ...

(QB_NEW_EN_HYPHEN)


[grammar] ~37-~37: Use a hyphen to join words.
Context: ...m 10 or RHEL10 based image: * RHEL10 based image These images are avai...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 35 - 37, Replace the nonstandard phrase "RHEL10
based" with the grammatically correct "RHEL 10-based" (and apply the same
pattern to any similar occurrences like "CentOSStream10 based" or "RHEL10-based
image" variants) so text reads e.g. "RHEL 10-based image" and "CentOS Stream
10-based image"; search for the exact strings "RHEL10 based" and "RHEL10 based
image" (and any "10 based"/"10based" variants) and update them for consistent
product naming and hyphenation throughout the README.


These images are available in the [Red Hat Container Catalog](https://access.redhat.com/containers/#/registry.access.redhat.com/rhel8/nginx-124).
These images are available in the [Red Hat Container Catalog](https://access.redhat.com/containers/#/registry.access.redhat.com/rhel10/nginx-126).
To download it run:

```
$ podman pull registry.access.redhat.com/rhel9/nginx-124
$ podman pull registry.access.redhat.com/rhel10/nginx-126
```

To build a RHEL8 based Nginx image, you need to run Docker build on a properly
To build a RHEL10 based Nginx image, you need to run Docker build on a properly
subscribed RHEL machine.

```
$ git clone --recursive https://github.com/sclorg/nginx-container.git
$ cd nginx-container
$ git submodule update --init
$ make build TARGET=rhel9 VERSIONS=1.24
$ make build TARGET=rhel10 VERSIONS=1.26
```

* **CentOS Stream based image**

This image is available on DockerHub. To download it run:

```
$ podman pull quay.io/sclorg/nginx-124-c9s
$ podman pull quay.io/sclorg/nginx-126-c10s
Comment on lines 58 to +61
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix registry wording: DockerHub vs Quay mismatch.

Line 58 says DockerHub, but Line 61 pulls from quay.io. Please align the text with the actual registry to avoid user confusion.

Suggested doc tweak
-    This image is available on DockerHub. To download it run:
+    This image is available on Quay.io. To download it run:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
This image is available on DockerHub. To download it run:
```
$ podman pull quay.io/sclorg/nginx-124-c9s
$ podman pull quay.io/sclorg/nginx-126-c10s
This image is available on Quay.io. To download it run:
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 60-60: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


[warning] 61-61: Dollar signs used before commands without showing output

(MD014, commands-show-output)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 58 - 61, Update the README wording to match the
actual registry used by the pull command: change the phrase referencing
"DockerHub" to "Quay" (or vice versa if you intend to pull from DockerHub) so
the description and the example command `podman pull
quay.io/sclorg/nginx-126-c10s` are consistent; ensure the repository host name
(quay.io) appears in the explanatory text and adjust the sample command if you
choose to reference Docker Hub instead.

```

To build a CentOS based Nginx image from scratch, run:
Expand All @@ -67,10 +67,10 @@ Choose either the CentOS Stream 9 or RHEL8 based image:
$ git clone --recursive https://github.com/sclorg/nginx-container.git
$ cd nginx-container
$ git submodule update --init
$ make build TARGET=c9s VERSIONS=1.24
$ make build TARGET=c10s VERSIONS=1.26
```

For using other versions of Nginx, just replace the `1.24` value by particular version
For using other versions of Nginx, just replace the `1.26` value by particular version
in the commands above.
Comment on lines +73 to 74
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Version guidance is inconsistent with later sections.

Line 73 says to replace 1.26 in commands above, but Build/Test examples later still use 1.24 and older targets. Please align the whole README to one baseline (or explicitly mark legacy examples), otherwise instructions conflict.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 73 - 74, The README currently references Nginx
version "1.26" in one spot but uses "1.24" and older in Build/Test examples,
causing conflicting instructions; update the README so all version mentions
align to a single baseline (e.g., change the "1.24" occurrences in the
Build/Test examples and any targets to "1.26"), or clearly label older examples
as "legacy" with an explicit note (e.g., mark sections like "Build/Test
examples" as Legacy/Deprecated) and add a short header stating which version is
the current baseline; search for and update every instance of "1.24" and other
older Nginx version strings, as well as the line that instructs replacing
`1.26`, to ensure consistency across the README.


Note: while the installation steps are calling `podman`, you can replace any such calls by `docker` with the same arguments.
Expand Down