Converts the Validated Patterns Operator file to asciidoc and review for changes #302
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: abhatt-rh The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
abhatt-rh
changed the title
|
Hi @danmacpherson and @mbaldessari, |
|
No major issues from my side. This is just the conversion and not the style and consistency review, right? If so, then: /lgtm |
|
New changes are detected. LGTM label has been removed. |
abhatt-rh
force-pushed
the
td-1431
branch
2 times, most recently
from
3b2ca34 to
9ff47d2
Compare
Hi @danmacpherson - This PR addresses both, the conversion and the style and consistency. |
|
Ah gotcha, I'll take a closer look after our vF2F. |
danmacpherson
left a comment
danmacpherson
left a comment
There was a problem hiding this comment.
Some minor feedback to implement. Otherwise, it's all good.
| + | ||
| To know the cluster group name for the patterns that you want to deploy, check the relevant pattern-specific requirements. | ||
| . Expand the *Git Config* section to reveal the options and enter the required information. | ||
| .. Change the *Target Repo* URL to your forked repository URL. For example, `+https://github.com/validatedpatterns/<pattern_name>+` to `+https://github.com/<your-git-username>/<pattern-name>+` |
There was a problem hiding this comment.
Does the the default actually say https://github.com/validatedpatterns/<pattern_name>? If so, this is a minor concern but users might also interpret https://github.com/<your-git-username>/<pattern-name> to be literal and not replaceable since it's following the same pattern as the default. Maybe we need to revise this line to also say to replace the <your-git-username> and <pattern-name> with their actual user name and the pattern name? Or am I overthinking this.
There was a problem hiding this comment.
No, it does not literally say https://github.com/validatedpatterns/<pattern_name>. The only variable is the pattern-name and hence that syntax <>.
Not sure if we need to spell that out but take a look at the actual screen capture and if you still feel we need to clarify it further, we can update the description to say so.
There was a problem hiding this comment.
Ah I understand now. Might need an additional verb to make that last line a complete sentence.
| .. Change the *Target Repo* URL to your forked repository URL. For example, `+https://github.com/validatedpatterns/<pattern_name>+` to `+https://github.com/<your-git-username>/<pattern-name>+` | |
| .. Change the *Target Repo* URL to your forked repository URL. For example, change `+https://github.com/validatedpatterns/<pattern_name>+` to `+https://github.com/<your-git-username>/<pattern-name>+` |
| menu: | ||
| learn: | ||
| parent: Infrastructure | ||
| title: Using the Validated Patterns Operator (asciidoc) |
There was a problem hiding this comment.
Drop the '(asciidoc)' before we merge it? Or do you want to kill the old md file first and then drop it?
There was a problem hiding this comment.
Hi @mbaldessari. Yes, I'll drop the asciidoc before I merge it and delete the old file (.md) at the same time.
abhatt-rh
left a comment
abhatt-rh
left a comment
There was a problem hiding this comment.
Hi @danmacpherson and @mbaldessari for your review.
I have addressed your comments. PTAL. The build is failing for known issues (mostly links to the older repo, which eventually redirect to the new site). Yet, i'll get them fixed in a follow-up PR
| + | ||
| To know the cluster group name for the patterns that you want to deploy, check the relevant pattern-specific requirements. | ||
| . Expand the *Git Config* section to reveal the options and enter the required information. | ||
| .. Change the *Target Repo* URL to your forked repository URL. For example, `+https://github.com/validatedpatterns/<pattern_name>+` to `+https://github.com/<your-git-username>/<pattern-name>+` |
There was a problem hiding this comment.
No, it does not literally say https://github.com/validatedpatterns/<pattern_name>. The only variable is the pattern-name and hence that syntax <>.
Not sure if we need to spell that out but take a look at the actual screen capture and if you still feel we need to clarify it further, we can update the description to say so.
|
Ignoring the failed HTMLTest check and merging this PR. Will address the failure in a follow-up PR |
3 participants
This PR converts the Validated Patterns Operator file to asciidoc and implements style and consistency changes
Issues: