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

[WFLY-20447] Fix mistakes in "http custom mechanism" readme #1024

Merged
merged 1 commit into from
Mar 10, 2025

Conversation

mskacelik
Copy link
Contributor

@mskacelik mskacelik commented Mar 5, 2025

Issue: https://issues.redhat.com/browse/WFLY-20447

While going through this quickstart I probably found some mistakes in the readme.

  • wrong path (.../modules/modules/...)
  • one section is copy pasted and is twice in the text
  • no mention of the restoring scripts

Also bit off topic, but how exactly does the password validation work for the custom mechanism, given that X-PASSWORD could be anything and response is still OK (200) (unlike the X-USERNAME)

@mskacelik mskacelik requested a review from emmartins as a code owner March 5, 2025 15:03
Copy link
Contributor

@emmartins emmartins left a comment

Choose a reason for hiding this comment

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

hi @mskacelik, thanks for this. I have a few changes to request, you should only change README-source.adoc, the README.adoc is just a flattened version of README-source.adoc that is auto updated after each PR merge.

So the other README.adoc changes you did should actually be around the following include, that is wrongly done twice:

:restoreScriptName: restore-configuration.cli
include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2]

The problem here is that such "included" content does not really supports multiple scripts, so now you may just remove the second include (line 238), and I will create a new JIRA to add multiple script support to that shared docs content; alternatively you can do that extra too in this PR, by improving the /shared-doc/restore-standalone-server-configuration-manual.adoc now.

@emmartins
Copy link
Contributor

@mskacelik by the way, do you have already a WildFly JIRA account? I created a JIRA for your contribution at https://issues.redhat.com/browse/WFLY-20447 , if you have an account I may assign it to you, otherwise I can help as proxy, no prob.

@emmartins
Copy link
Contributor

emmartins commented Mar 5, 2025

@fjuma it's a bit unusual place for user requests, but perhaps you want to reply here to @mskacelik , please see his question in issue description?

@mskacelik
Copy link
Contributor Author

mskacelik commented Mar 5, 2025

Ah, that makes sense, thank you.

alternatively you can do that extra too in this PR

Yea sure, could give it a try. :)

by the way, do you have already a WildFly JIRA account?

Yes I do, Marek Skacelik ([email protected])

@mskacelik
Copy link
Contributor Author

hi @mskacelik, thanks for this. I have a few changes to request, you should only change README-source.adoc, the README.adoc is just a flattened version of README-source.adoc that is auto updated after each PR merge.

So the other README.adoc changes you did should actually be around the following include, that is wrongly done twice:

:restoreScriptName: restore-configuration.cli
include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2]

The problem here is that such "included" content does not really supports multiple scripts, so now you may just remove the second include (line 238), and I will create a new JIRA to add multiple script support to that shared docs content; alternatively you can do that extra too in this PR, by improving the /shared-doc/restore-standalone-server-configuration-manual.adoc now.

Shouldn't the included file on line 226 be: restore-standalone-server-configuration.adoc instead of restore-standalone-server-configuration-manual.adoc? This explains the :restoreScriptName: restore-configuration.cli above it as a parameter (in the manual, restoreScriptName is not used) and also why the manual is included below it (since it continues the non-manual section nicely).

@mskacelik mskacelik force-pushed the http-custom-mechanism-readme-fix branch from 186129e to b94b9c2 Compare March 5, 2025 17:37
@mskacelik mskacelik changed the title Fix mistakes in "http custom mechanism" readme [WFLY-20447] Fix mistakes in "http custom mechanism" readme Mar 5, 2025
@mskacelik mskacelik requested a review from emmartins March 6, 2025 13:05
@mskacelik mskacelik force-pushed the http-custom-mechanism-readme-fix branch from b94b9c2 to cdbc278 Compare March 7, 2025 11:16
@emmartins emmartins merged commit e82d23d into wildfly:main Mar 10, 2025
12 checks passed
@emmartins
Copy link
Contributor

@mskacelik thank you :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants