Skip to content

Commit

Permalink
update readme section with documentation links
Browse files Browse the repository at this point in the history
Signed-off-by: Mohit Suman <[email protected]>
  • Loading branch information
mohitsuman committed Oct 16, 2022
1 parent d358fd5 commit a809c47
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ There are only a few guidelines that we need contributors to follow.
5. Open the folder in VS Code

## Developing the extension
We strongly suggest that you use [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and [Eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) to ease the development of the extension. We are using multiple tools to keep codebase clean, maintainable and code readable.
We strongly suggest that you use [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and [ESlint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) to ease the development of the extension. We are using multiple tools to keep codebase clean, maintainable and code readable.
1. Once you have all package dependencies installed (`npm install`) you can compile the extension, so you are sure you have all the dependencies installed correctly:
```
npm run build
Expand Down
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,19 @@ This extension contributes two views (Knative and Functions) and the following s
* `Knative: Open in Browser`: Open the deployed function in your browser
* `Knative: Refresh View`: Refresh the Function Tree View

## Documentation

- [What is OpenShift Serverless](https://www.redhat.com/en/technologies/cloud-computing/openshift/serverless)
- [Setting up OpenShift Serverless Functions - Red Hat Official Documentation](https://docs.openshift.com/container-platform/4.11/serverless/functions/serverless-functions-setup.html)
- [Serverless Function CLI docs](https://github.com/knative/func)
- [Knative Docs](https://knative.dev/docs/)
## Release Notes

> See [CHANGELOG](CHANGELOG.md) for details.
## Contributing

This is an open source project open to anyone. This project welcomes contributions and suggestions!
This is an open source project open to anyone. We are always looking for contributions from the Function Developer community.

For information on getting started, refer to the [CONTRIBUTING instructions](CONTRIBUTING.md).

Expand All @@ -79,6 +85,8 @@ If you discover an issue please file a bug and we will fix it as soon as possibl
* File a bug in [GitHub Issues](https://github.com/redhat-developer/vscode-knative/issues).
* Open a [Discussion on GitHub](https://github.com/redhat-developer/vscode-knative/discussions).

The func Task Force meets @ 10:30 PST every Tuesday, we'd love to have you! For more information, see the invitation on the [Knative Team Calendar](https://calendar.google.com/calendar/u/0/embed?src=knative.team_9q83bg07qs5b9rrslp5jor4l6s@group.calendar.google.com).

## License

MIT, See [LICENSE](LICENSE) for more information.
Expand Down
2 changes: 1 addition & 1 deletion src/functions/function-command/create-function.ts
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ export const def: WizardDefinition = {
if (result.error) {
telemetryLogError('Fail_to_create_function', result.error);
// eslint-disable-next-line @typescript-eslint/no-floating-promises
vscode.window.showErrorMessage(`Fail create Function: ${getStderrString(result.error)}`);
vscode.window.showErrorMessage(`Failed to create Function: ${getStderrString(result.error)}`);
return false;
}
return true;
Expand Down

0 comments on commit a809c47

Please sign in to comment.