-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
add documentation for running knative on IBM s390x/IBM ppc64le platforms #6043
Conversation
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
I find the doc confusing:
I would suggest taking a straight forward approach and stating in the Note something like: "Use this alternative documentation to install a networking layer on IBM Z and IBM Power platforms." Then in the documentation, I would suggest to include all steps needed to get to a working networking layer. Instead of "Customizing 3-scale-kourier-gateway on IBM Z and IBM P platform" as a header, I would use "Install a networking layer on IBM Z and IBM Power platforms." Instead of "To run 3-scale-kourier-gateway on IBM Z and IBM P platforms, ..." I suggest "To install a networking layer on IBM Z and IBM P platforms, ..." and spell out the steps to do that |
@davidhadas 3-scale-kourier-gateway is the deployment name for kourier gateway deployed as part of the kourier deployment. I used the same deployment name, so users who face issues pulling images can relate to. I will create a single document instead of redirecting user multiple times to different documentations. But there is no difference between standard deployment and deployment we are suggesting. We are patching the image for the same deployment that is done via standard knative scripts. |
I got that , but it is not reflected in the added Knative documentation. I suggest spelling out the information rather than assuming readers will figure it out somehow.
If this is a preliminary step that needs to be taken before continuing to the other steps, you can define it as a preliminary step and not repeat the other steps. In any case, it needs to be very clear to the reader what (s)he should be doing + the order of things. |
@davidhadas can you please review and let me know if this looks good? I updated the document to be more readable and why we need to patch the 3-scale-kourier-gateway. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please consider the below suggested changes.
Please verify that the provided instructions and overall guidance are correct and accurate.
docs/install/yaml-install/serving/install-serving-with-yaml-on-IBM-Z-and-IBM-P.md
Outdated
Show resolved
Hide resolved
docs/install/yaml-install/serving/install-serving-with-yaml-on-IBM-Z-and-IBM-P.md
Outdated
Show resolved
Hide resolved
Co-authored-by: David Hadas <[email protected]>
@davidhadas I think sub point in docs/install/yaml-install/serving/install-serving-with-yaml-on-IBM-Z-and-IBM-P.md is not rendering properly in the deploy preview. I will see how to add them in markdown and commit it. |
@davidhadas I have corrected the alignment. Can you please review it again? |
docs/install/yaml-install/serving/install-serving-with-yaml-on-IBM-Z-and-IBM-P.md
Outdated
Show resolved
Hide resolved
…-IBM-Z-and-IBM-P.md
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: davidhadas, dilipgb The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This document updates the installation steps needed to install knative on IBM s390x and IBM ppc64le platforms.