Copy-edit based on the style guide #11003
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Made the following changes:
- Used present tense.
- Removed latin phrases
- {{< tab name=“Content File #1” include=“example1” />}} was not shown as code. Updated it.
- Copy-edited the description for include under Tabs.
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
size/S
Collaborator
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit 16df9fc https://deploy-preview-11003--kubernetes-io-master-staging.netlify.com |
Bradamant3
suggested changes
Nov 15, 2018
Contributor
Bradamant3
left a comment
Bradamant3
left a comment
There was a problem hiding this comment.
Nice cleanup overall! Added a few more things, easy to miss. Thanks!
| ``` | ||
|
|
||
| Will render to: | ||
| It renders to: |
Contributor
There was a problem hiding this comment.
Make consistent with the usage you change further down the page:
s/It renders/Renders
| ### Feature state code | ||
|
|
||
| Below is the template code for each available feature state. | ||
| Given below is the template code for each feature state. |
Contributor
There was a problem hiding this comment.
I think we can remove this sentence altogether. It adds no value.
Contributor
Author
There was a problem hiding this comment.
Agreed. I will remove it.
|
|
||
| * If your inner content is markdown, you must use `%`-delimiter to surorund the tab, e.g. `{{%/* tab name="Tab 1" %}}This is **markdown**{{% /tab */%}}` | ||
| * `include`: The file to include in the tab. If the tab lives in a Hugo [leaf bundle](https://gohugo.io/content-management/page-bundles/#leaf-bundles), the file -- which can be any MIME type supported by Hugo -- will be looked up in the bundle itself. If not, the content page that needs to be included is looked up relative to the current page. Note that with the `include`, you do not have any shortcode inner content and must use the self-closing syntax. For example, <code>{{</* tab name="Content File #1" include="example1" /*/>}}</code>. The language needs to be specified under `codelang` or the language is taken based on the file name. Non-content files are code-highlighted by default. | ||
| * If your inner content is markdown, you must use the `%`-delimiter to surorund the tab. For example, `{{%/* tab name="Tab 1" %}}This is **markdown**{{% /tab */%}}` |
Contributor
Author
There was a problem hiding this comment.
Good catch :) Didn't notice the typo in the original text before.
| * `include`: The file to include in the tab. If the tab lives in a Hugo [leaf bundle](https://gohugo.io/content-management/page-bundles/#leaf-bundles), the file -- which can be any MIME type supported by Hugo -- will be looked up in the bundle itself. If not, the content page to include will be looked up relative to the current. Note that with the `include` you will not have any shortcode inner content and must use the self-closing syntax, e.g. {{</* tab name="Content File #1" include="example1" /*/>}}. Non-content files will be code-highlighted. The language to use will be taken from the filename if not provided in `codelang`. | ||
|
|
||
| * If your inner content is markdown, you must use `%`-delimiter to surorund the tab, e.g. `{{%/* tab name="Tab 1" %}}This is **markdown**{{% /tab */%}}` | ||
| * `include`: The file to include in the tab. If the tab lives in a Hugo [leaf bundle](https://gohugo.io/content-management/page-bundles/#leaf-bundles), the file -- which can be any MIME type supported by Hugo -- will be looked up in the bundle itself. If not, the content page that needs to be included is looked up relative to the current page. Note that with the `include`, you do not have any shortcode inner content and must use the self-closing syntax. For example, <code>{{</* tab name="Content File #1" include="example1" /*/>}}</code>. The language needs to be specified under `codelang` or the language is taken based on the file name. Non-content files are code-highlighted by default. |
Contributor
There was a problem hiding this comment.
s/will be looked up/is looked up
jimangel
reviewed
Nov 15, 2018
Member
jimangel
left a comment
jimangel
left a comment
There was a problem hiding this comment.
Agree with @Bradamant3's review. Good work!
Bradamant3
approved these changes
Nov 16, 2018
Contributor
|
/lgtm |
k8s-ci-robot
added
the
lgtm
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Bradamant3 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 |
k8s-ci-robot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Made the following changes: