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.

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

[MINOR][DOCS] Fixed closing tags in running-on-kubernetes.md #35561

Closed
wants to merge 1 commit into from

Conversation

zr-msft
Copy link

@zr-msft zr-msft commented Feb 17, 2022

This contribution is my original work and I license the work to the project under the project’s open source license.

What changes were proposed in this pull request?

Several <code> elements in running-on-kubernetes.md had typos in their closing tags, causing rendering issues on the HTML site. Example of rendering issue:

https://spark.apache.org/docs/3.2.1/running-on-kubernetes.html#configuration

This PR fixes those typos and resolves the rendering issue.

Why are the changes needed?

The typo fixes allows the HTML site to render the article correctly.

Does this PR introduce any user-facing change?

Yes, currently the site shows several headers and closing tags as plain text:
https://spark.apache.org/docs/3.2.1/running-on-kubernetes.html#configuration

This PR allows those headers to be correctly rendered and no longer shows the table's closing tags.

How was this patch tested?

No tests were added. I did a local build of the site per the instructions and confirmed the HTML renders correctly.

@github-actions github-actions bot added the DOCS label Feb 17, 2022
@dongjoon-hyun dongjoon-hyun changed the title [Docs] fixed typo in closing tags causing rendering issues in running-on-kubernetes.md [MINOR][DOCS] Fixed closing tags in running-on-kubernetes.md Feb 18, 2022
Copy link
Member

@dongjoon-hyun dongjoon-hyun left a comment

Choose a reason for hiding this comment

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

+1, LGTM. Thank you, @zr-msft .
Welcome to the Apache Spark community.
Merged to master.

@dongjoon-hyun
Copy link
Member

There is a conflict on branch-3.2. You can make a backporting PR against branch-3.2 if you want.

@zr-msft zr-msft deleted the fix-doc-running-on-kubernetes branch February 18, 2022 16:22
zr-msft pushed a commit to zr-msft/spark that referenced this pull request Feb 18, 2022
dongjoon-hyun pushed a commit that referenced this pull request Feb 18, 2022
### What changes were proposed in this pull request?
Per [feedback](#35561 (comment)) on #35561 from dongjoon-hyun, I'm back porting fixes from `master` to `branch-3.2` since there was a conflict. From original PR:

> Several `<code>` elements in running-on-kubernetes.md had typos in their closing tags, causing rendering issues on the HTML site. Example of rendering issue:
>
> https://spark.apache.org/docs/3.2.1/running-on-kubernetes.html#configuration
>
> This PR fixes those typos and resolves the rendering issue.

### Why are the changes needed?

Changes from #35561 were in conflict with `branch-3.2`. From original PR:

> The typo fixes allows the HTML site to render the article correctly.

### Does this PR introduce _any_ user-facing change?
From original PR:

> Yes, currently the site shows several headers and closing tags as plain text:
> https://spark.apache.org/docs/3.2.1/running-on-kubernetes.html#configuration
>
> This PR allows those headers to be correctly rendered and no longer shows the table's closing tags.

### How was this patch tested?
No tests were added. I did a local build of the site per the instructions and confirmed the HTML renders correctly.

Closes #35572 from zr-msft/backport-pr-35561.

Authored-by: Microsoft Learn Student <learn@contoso.com>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
@zr-msft
Copy link
Author

zr-msft commented Jun 7, 2022

@dongjoon-hyun I've periodically checked the docs site and I'm not seeing any changes show up based on commits i've added from this PR:

I'm also not seeing earlier commits show up:

The most recent commit that shows up on this page is from Jul 18, 2021:

@dongjoon-hyun
Copy link
Member

Hi, @zr-msft . Did you check Apache Spark 3.3 RC5 document? It should be there.

For branch-3.2, your contribute arrived after 3.2.1. So, it will be Apache Spark 3.2.2.

@zr-msft
Copy link
Author

zr-msft commented Jun 7, 2022

thank you @dongjoon-hyun, I made the assumption that the live site was updated after a PR was merged. I see my updates on the rc5 docs and thank you for the quick response

@dongjoon-hyun
Copy link
Member

Thank YOU for your contribution. :)

kazuyukitanimura pushed a commit to kazuyukitanimura/spark that referenced this pull request Aug 10, 2022
### What changes were proposed in this pull request?
Per [feedback](apache#35561 (comment)) on apache#35561 from dongjoon-hyun, I'm back porting fixes from `master` to `branch-3.2` since there was a conflict. From original PR:

> Several `<code>` elements in running-on-kubernetes.md had typos in their closing tags, causing rendering issues on the HTML site. Example of rendering issue:
>
> https://spark.apache.org/docs/3.2.1/running-on-kubernetes.html#configuration
>
> This PR fixes those typos and resolves the rendering issue.

### Why are the changes needed?

Changes from apache#35561 were in conflict with `branch-3.2`. From original PR:

> The typo fixes allows the HTML site to render the article correctly.

### Does this PR introduce _any_ user-facing change?
From original PR:

> Yes, currently the site shows several headers and closing tags as plain text:
> https://spark.apache.org/docs/3.2.1/running-on-kubernetes.html#configuration
>
> This PR allows those headers to be correctly rendered and no longer shows the table's closing tags.

### How was this patch tested?
No tests were added. I did a local build of the site per the instructions and confirmed the HTML renders correctly.

Closes apache#35572 from zr-msft/backport-pr-35561.

Authored-by: Microsoft Learn Student <learn@contoso.com>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants