Fixed markdown syntax in Python serving README.md #5206
Conversation
This PR fixes markdown syntax of the `serving/hello-world/helloworld-python/README.md` file. Making it easier to read for new starters
|
|
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
knative-prow
bot
added
the
size/L
|
Welcome @dhruvy1! It looks like this is your first PR to knative/docs 🎉 |
knative-prow
bot
added
the
needs-ok-to-test
|
Hi @dhruvy1. Thanks for your PR. I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
| @@ -35,7 +35,7 @@ cd knative-docs/code-samples/serving/hello-world/helloworld-python | |||
| cd app | |||
| ``` | |||
|
|
|||
| 1. Create a file named `app.py` and copy the following code block into it: | |||
| 2. Create a file named `app.py` and copy the following code block into it: | |||
There was a problem hiding this comment.
AFAIK the numbers shouldn't need to be specifically called out like this, we should be able to use 1. for each of them, which is easier for future maintenance: https://www.markdownguide.org/basic-syntax/#lists-1
At https://github.com/knative/docs/tree/main/code-samples/serving/hello-world/helloworld-python it looks like it only caused rendering issues because of the broken === "kn" bits, etc. Please leave these as 1. throughout the doc.
| 1. Create a new file, `service.yaml` and copy the following service | ||
| definition into the file. Make sure to replace `{username}` with your | ||
| Docker Hub username or with the URL provided by your container registry |
There was a problem hiding this comment.
| 1. Create a new file, `service.yaml` and copy the following service | |
| definition into the file. Make sure to replace `{username}` with your | |
| Docker Hub username or with the URL provided by your container registry | |
| 1. Create a new file, `service.yaml` and copy the following Service | |
| definition into the file. Make sure to replace `{username}` with your | |
| Docker Hub username or with the URL provided by your container registry: |
| kubectl apply --filename service.yaml | ||
| ``` | ||
| ```bash | ||
| kubectl apply --filename service.yaml |
There was a problem hiding this comment.
| kubectl apply --filename service.yaml | |
| kubectl apply -f service.yaml |
|
|
||
| With `kn` you can deploy the service with | ||
| 1. With `kn` you can deploy the service with |
There was a problem hiding this comment.
| 1. With `kn` you can deploy the service with | |
| 1. Create the Service by entering the command: |
| This will wait until your service is deployed and ready, and ultimately it | ||
| will print the URL through which you can access the service. |
There was a problem hiding this comment.
| This will wait until your service is deployed and ready, and ultimately it | |
| will print the URL through which you can access the service. | |
| Once the Service is ready, the URL for the Service is printed in the terminal output. |
| kubectl delete --filename service.yaml | ||
| ``` | ||
| ```bash | ||
| kubectl delete --filename service.yaml |
There was a problem hiding this comment.
| kubectl delete --filename service.yaml | |
| kubectl delete -f service.yaml |
|
/ok-to-test |
knative-prow
bot
added
ok-to-test
|
@dhruvy1 thanks for the PR! I've added a few comments, mostly about formatting or suggestions for readability of content. |
abrennan89
removed
the
do-not-merge/hold
|
/lgtm Would've been nice to have had review comments implemented, but merging anyway since I don't want this issue to get stale. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abrennan89, dhruvy1 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 |
knative-prow
bot
added
the
approved
This PR fixes markdown syntax in the
serving/hello-world/helloworld-python/README.mdfile. Making it easier to read for new starters."Fixes #issue-number" or "Add description of the problem this PR solves"
Proposed Changes
serving/hello-world/helloworld-python/README.mdfile