Fix section "3-Bad Word Service" in e2e tutorial #6425
Conversation
The latest func cli generates a different Python function template than shown in the tutorial. There is no setup.py anymore and the project uses a toml file for configuration. The entire section was updated and code was corrected. The required func cli version `v0.46.0` was added to the tutorial with a link to the GitHub func repository tags page. The `solution-create-bad-word-filter-service.md` was removed because it was identical to the `create-bad-word-filter-service.md`. All references to it were removed. Issue knative#6420. Signed-off-by: Stanislav Jakuschevskij <[email protected]>
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
knative-prow
bot
added
the
size/L
| Knative Function enables you to easily create, build, and deploy stateless, event-driven functions as [Knative Services](https://knative.dev/docs/serving/services/#:~:text=Knative%20Services%20are%20used%20to,the%20Service%20to%20be%20configured){:target="_blank"} by using the func CLI. | ||
|
|
||
| In order to do so, you need to install the func CLI. You can follow the [official documentation](https://knative.dev/docs/getting-started/install-func/){:target="_blank"} to install the func CLI. | ||
| In order to do so, you need to install the func CLI `v0.46.0`. You can follow the [official documentation](https://knative.dev/docs/getting-started/install-func/){:target="_blank"} to install the func CLI with the appropriate version. If the latest version is above `v0.46.0` use the [GitHub func repository tag](https://github.com/knative/func/tags) page to get the correct version. |
There was a problem hiding this comment.
I don't think we should mention the func version. This is the go module version and not the user facing version v1.19.3
Plus I wouldn't want to have to bump this documentation with every release
cc @lkingland can we get func to show the user facing version?
There was a problem hiding this comment.
No problem, I will remove mentioning the version number.
I did not know that about the "user facing version", thanks for clarifying.
When I worked through the e2e tutorial it didn't work in step 2, 3 and 7 because the latest version of the used CLIs like func and kamel changed. For example func was generating a different function template.
Maybe we could add a "Prerequisites" section in the e2e Overview where we mention the needed version numbers to make sure it works? Otherwise a new user will face the same issues I did next year. Or how would you go about it?
P.S.: I also mention in my fix of step 7 the Camel K version because the kamel CLI does not support installation anymore. I will remove it there too (=> done).
|
@dprotaso Since I am not aware of the latest changes that func has, and haven't touched the code for a while; given the short time period before releasing, I think the folks from function team would be the best reviewer for this PR |
Signed-off-by: Stanislav Jakuschevskij <[email protected]>
|
/lgtm I'll merge this now and run through it myself. cc @lkingland @matejvasek in the meantime for an async review |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dprotaso, twoGiants 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
|
/cherry-pick release-1.19 |
|
@dprotaso: new pull request created: #6432 In response to this:
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-sigs/prow repository. |
The latest
funccli generates a different Python function template than shown in the tutorial. There is nosetup.pyanymore and the project uses atomlfile for configuration. The entire section was updated and code was corrected.The required
funccli versionv0.46.0was added to the tutorial with a link to the GitHub func repository tags page.The
solution-create-bad-word-filter-service.mdwas removed because it was identical to thecreate-bad-word-filter-service.md. All references to it were removed.Fixes #6420.
Proposed Changes
Update 3 Create Bad Word Service.
solution-create-bad-word-filter-service.mdand references to it.