-
Notifications
You must be signed in to change notification settings - Fork 1.3k
docs: add language specifiers to fenced code blocks #6553
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
base: main
Are you sure you want to change the base?
docs: add language specifiers to fenced code blocks #6553
Conversation
❌ Deploy Preview for knative failed.Built without sensitive environment variables
|
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: anjalii-28 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Looks like the Netlify / Pages preview workflows are awaiting approval. |
|
Hi @anjalii-28 The issue this PR addresses requires familiarity with the knative commands, It is not a good-first-issue. Hence revise it manually. |
|
oh thanks, noted ! |
Cali0707
left a comment
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.
This is a great cleanup @anjalii-28 !
I think it is worth re-opening this PR and then we can merge it in with the comments I left
I'm not sure if this has cleaned up all the code blocks in the docs folder (haven't had time to check if this gets all of them), but this is definitely an improvement
| Now your scripts can access it via `localhost:8321`: | ||
|
|
||
| ```shell | ||
| ```bash |
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.
I may make this one just text
| We can now run our function locally by issuing `func run` on the command line. Once it is running there will a system log like below: | ||
|
|
||
| ```shell | ||
| ```bash |
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.
I would make this one just text
| You should have a webhook URL that looks like this: | ||
|
|
||
| ```sh | ||
| ```bash |
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.
I would make this one text
| You will see the output with the registry address: | ||
|
|
||
| ```sh | ||
| ```bash |
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.
I would make this one text
| You should see this message if the secret is created successfully: | ||
|
|
||
| ```sh | ||
| ```bash |
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.
I would make this one text
| ``` | ||
|
|
||
| ```sh | ||
| ```bash |
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.
I would make this one text
| You should see a service named `pipe` listed: | ||
|
|
||
| ```sh | ||
| ```bash |
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.
I would make this one text
|
|
||
| Example output: | ||
| ```shell | ||
| ```bash |
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.
I would make this one text
|
|
||
| Example output: | ||
| ```shell | ||
| ```bash |
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.
I would make this one text
| Example Output: | ||
|
|
||
| ```sh | ||
| ```bash |
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.
I would make this one text
This PR improves documentation readability by adding or correcting language
specifiers for fenced code blocks.
Changes are mechanical and limited to:
Directories touched:
Fixes #6526