search

apache / openwhisk-deploy-kube

The Apache OpenWhisk Kubernetes Deployment repository supports deploying the Apache OpenWhisk system on Kubernetes and OpenShift clusters.
https://openwhisk.apache.org/
Apache License 2.0
296 stars 228 forks source link

Add backquotes for file names in docs #679

Closed izackwu closed 3 years ago

izackwu commented 3 years ago

Hi, I'm new to OpenWhisk 😄

When reading these docs to deploy OpenWhisk, I noticed the inconsistent use of backquotes for file names: sometimes it's `mycluster.yaml` while sometimes it's just plain mycluster.yaml. I think the former looks better and thus make this PR.

izackwu commented 3 years ago

BTW, I also noticed some other markdown formatting issues like redundant spaces, missing blank lines, and improper indentation. (Of course, with the help of a markdown plugin for VSCode.)

I didn't include them in this PR as I'm not sure whether it's necessary to make docs strictly well-formatted.

rabbah commented 3 years ago

Thank you for this patch @keithnull 🎉

dgrove-oss commented 3 years ago

Thanks! Merged. If you want to submit a PR to improve formatting, that would be fine.