Skip to content

[SPARK-33397][YARN][DOC] Fix generating md to html for available-patterns-for-shs-custom-executor-log-url #30298

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
Closed
wants to merge 2 commits into from
Closed

[SPARK-33397][YARN][DOC] Fix generating md to html for available-patterns-for-shs-custom-executor-log-url #30298

wants to merge 2 commits into from

Conversation

@yaooqinn
Copy link
Member

@yaooqinn yaooqinn commented Nov 9, 2020 •
edited
Loading

What changes were proposed in this pull request?

  1. replace {{}} with {{}}
  2. using <code></code> in td-tag

Why are the changes needed?

to fix this.
image

Does this PR introduce any user-facing change?

yes, you will see the correct online doc with this change

image

How was this patch tested?

shown as the above pic via jekyll serve.

@yaooqinn
Copy link
Member Author

yaooqinn commented Nov 9, 2020

cc @HyukjinKwon @cloud-fan @maropu @HeartSaVioR thanks

@github-actions github-actions bot added the DOCS label Nov 9, 2020
@SparkQA
Copy link

SparkQA commented Nov 9, 2020

Test build #130786 has finished for PR 30298 at commit eee8ee6.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@SparkQA
Copy link

SparkQA commented Nov 9, 2020

Test build #130788 has finished for PR 30298 at commit 078bae1.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@SparkQA
Copy link

SparkQA commented Nov 9, 2020

Kubernetes integration test starting
URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/35397/

@SparkQA
Copy link

SparkQA commented Nov 9, 2020

Kubernetes integration test starting
URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/35396/

maropu
maropu reviewed Nov 9, 2020
View reviewed changes
docs/running-on-yarn.md
For example, suppose you would like to point log url link to Job History Server directly instead of let NodeManager http server redirects it, you can configure `spark.history.custom.executor.log.url` as below:

`{{HTTP_SCHEME}}<JHS_HOST>:<JHS_PORT>/jobhistory/logs/{{NM_HOST}}:{{NM_PORT}}/{{CONTAINER_ID}}/{{CONTAINER_ID}}/{{USER}}/{{FILE_NAME}}?start=-4096`
<code>&#123;&#123;HTTP_SCHEME&#125;&#125;&lt;JHS_HOST&gt;:&lt;JHS_PORT&gt;/jobhistory/logs/&#123;&#123;NM_HOST&#125;&#125;:&#123;&#123;NM_PORT&#125;&#125;/&#123;&#123;CONTAINER_ID&#125;&#125;/&#123;&#123;CONTAINER_ID&#125;&#125;/&#123;&#123;USER&#125;&#125;/&#123;&#123;FILE_NAME&#125;&#125;?start=-4096</code>
Copy link
Member

@maropu maropu Nov 9, 2020

Choose a reason for hiding this comment

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

we need to change < ->&lt; and > -> &gt;?

Copy link
Member Author

@yaooqinn yaooqinn Nov 9, 2020

Choose a reason for hiding this comment

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

yes. otherwise，they become tags inside codeblock

@maropu maropu changed the title [SPARK-33397][DOC] Fix generating md to html for available-patterns-for-shs-custom-executor-log-url [SPARK-33397][YARN][DOC] Fix generating md to html for available-patterns-for-shs-custom-executor-log-url Nov 9, 2020
@SparkQA
Copy link

SparkQA commented Nov 9, 2020

Kubernetes integration test status success
URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/35396/

@SparkQA
Copy link

SparkQA commented Nov 9, 2020

Kubernetes integration test status success
URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/35397/

cloud-fan
cloud-fan approved these changes Nov 9, 2020
View reviewed changes
Copy link
Contributor

@cloud-fan cloud-fan left a comment

Choose a reason for hiding this comment

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

LGTM if you have generated the doc and verified locally.

@maropu
Copy link
Member

maropu commented Nov 10, 2020

LGTM (I've checked the generated page manually)

@maropu maropu closed this in 036c11b Nov 10, 2020
maropu pushed a commit that referenced this pull request Nov 10, 2020
@yaooqinn @maropu
[SPARK-33397][YARN][DOC] Fix generating md to html for available-patt…
a418495 
…erns-for-shs-custom-executor-log-url

### What changes were proposed in this pull request?

1. replace `{{}}`  with `&#123;&#123;&#125;&#125;`
2. using `<code></code>` in td-tag

### Why are the changes needed?

to fix this.
![image](https://user-images.githubusercontent.com/8326978/98544155-8c74bc00-22ce-11eb-8889-8dacb726b762.png)

### Does this PR introduce _any_ user-facing change?

yes, you will see the correct online doc with this change

![image](https://user-images.githubusercontent.com/8326978/98545256-2e48d880-22d0-11eb-9dd9-b8cae3df8659.png)

### How was this patch tested?

shown as the above pic via jekyll serve.

Closes #30298 from yaooqinn/SPARK-33397.

Authored-by: Kent Yao <[email protected]>
Signed-off-by: Takeshi Yamamuro <[email protected]>
(cherry picked from commit 036c11b)
Signed-off-by: Takeshi Yamamuro <[email protected]>
@maropu
Copy link
Member

maropu commented Nov 10, 2020

Merged to master/branch-3.0. Thanks!

@HeartSaVioR
Copy link
Contributor

HeartSaVioR commented Nov 10, 2020

Late +1. Thanks for fixing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maropu maropu maropu left review comments

@cloud-fan cloud-fan cloud-fan approved these changes

Assignees

No one assigned

Labels

DOCS

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@yaooqinn @SparkQA @maropu @HeartSaVioR @cloud-fan