Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Replace html tables with markdown #16190

Merged
merged 1 commit into from
Sep 12, 2019
Merged

Replace html tables with markdown #16190

merged 1 commit into from
Sep 12, 2019

Conversation

savitharaghunathan
Copy link
Member

@savitharaghunathan savitharaghunathan commented Sep 2, 2019 •
edited
Loading

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Sep 2, 2019
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 2, 2019
@netlify
Copy link

netlify bot commented Sep 2, 2019 •
edited
Loading

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 4839a59

https://deploy-preview-16190--kubernetes-io-master-staging.netlify.com

@savitharaghunathan savitharaghunathan changed the title WIP: Replace tables with markdown Replace html tables with markdown Sep 2, 2019
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 2, 2019
@savitharaghunathan
Copy link
Member Author

/assign @ryanmcginnis

aimeeu
aimeeu suggested changes Sep 3, 2019
View reviewed changes
Copy link
Contributor

@aimeeu aimeeu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this pull request. It was more complicated than I thought it would be when I created the issue. Would you remove the HTML tags within the tables so the code is all Markdown instead of a mixture of Markdown and HTML?

content/en/docs/contribute/style/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/contribute/style/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/contribute/style/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/contribute/style/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/contribute/style/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/contribute/style/style-guide.md Outdated Show resolved Hide resolved
savitharaghunathan
savitharaghunathan commented Sep 3, 2019
View reviewed changes
Copy link
Member Author

@savitharaghunathan savitharaghunathan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have replaced various html tags with corresponding markdown values.Please let me know if I have missed any.

aimeeu
aimeeu reviewed Sep 5, 2019
View reviewed changes
Copy link
Contributor

@aimeeu aimeeu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your work on this PR! @sftim or one of the other Reviewers needs to give a "lgtm" review.

@savitharaghunathan
Copy link
Member Author

@aimeeu Thank you. I will wait for Tim, and squash the commits into one if there is no further change.

@sftim
Copy link
Contributor

sftim commented Sep 6, 2019

/lgtm

(will need another one after squashing, or an approver can /lgtm /approve in a single comment)

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Sep 6, 2019
@sftim
Copy link
Contributor

sftim commented Sep 6, 2019

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 6, 2019
@ryanmcginnis ryanmcginnis removed their assignment Sep 6, 2019
@sftim sftim removed their assignment Sep 11, 2019
zacharysarah
zacharysarah suggested changes Sep 11, 2019
View reviewed changes
Copy link
Contributor

@zacharysarah zacharysarah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@savitharaghunathan Thanks for this PR. Most of it looks great! Some of the markup inside tables isn't rendering properly, however:

https://deploy-preview-16190--kubernetes-io-master-staging.netlify.com/docs/contribute/style/style-guide/#links

In addition to formatting with Markdown instead of HTML entities, you may need to code-fence some characters or escape them.

content/en/docs/contribute/style/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/contribute/style/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/contribute/style/style-guide.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 11, 2019
@savitharaghunathan
Copy link
Member Author

@zacharysarah Thank you for the review. I have made the changes, Can you review once again ?

zacharysarah
zacharysarah suggested changes Sep 12, 2019
View reviewed changes
Copy link
Contributor

@zacharysarah zacharysarah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@savitharaghunathan Sorry, just one more set of nits because of the size difference between regular table text and inline code, and also correcting an example. Thanks for making the changes!

content/en/docs/contribute/style/style-guide.md Outdated Show resolved Hide resolved
@savitharaghunathan
Copy link
Member Author

@zacharysarah, I have squashed all commits into one.

@zacharysarah
Copy link
Contributor

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 12, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zacharysarah

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 12, 2019
@k8s-ci-robot k8s-ci-robot merged commit 8f2d392 into kubernetes:master Sep 12, 2019
@savitharaghunathan savitharaghunathan deleted the replacetableswithmarkdown branch September 12, 2019 01:20
wahyuoi pushed a commit to wahyuoi/website that referenced this pull request Sep 18, 2019
@savitharaghunathan @wahyuoi
Updating style.md and write-new-topic.md with markdowns (kubernetes#1…
bb49207 
…6190)
@savitharaghunathan savitharaghunathan mentioned this pull request Sep 25, 2019
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@zacharysarah zacharysarah zacharysarah requested changes

@Rajakavitha1 Rajakavitha1 Awaiting requested review from Rajakavitha1

@stewart-yu stewart-yu Awaiting requested review from stewart-yu

@aimeeu aimeeu Awaiting requested review from aimeeu

Assignees

@zacharysarah zacharysarah

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation Style Section: Replace HTML tables with Markdown tables
6 participants
@savitharaghunathan @sftim @zacharysarah @k8s-ci-robot @aimeeu @ryanmcginnis