Skip to content

[SPARK-28543][DOCS][WebUI] Document Spark Jobs page#25424

Closed
planga82 wants to merge 5 commits intoapache:masterfrom
planga82:feature/SPARK-28543_ImproveWebUIDocs
Closed

[SPARK-28543][DOCS][WebUI] Document Spark Jobs page#25424
planga82 wants to merge 5 commits intoapache:masterfrom
planga82:feature/SPARK-28543_ImproveWebUIDocs

Conversation

@planga82
Copy link
Contributor

@planga82 planga82 commented Aug 12, 2019

What changes were proposed in this pull request?

New documentation to explain in detail Web UI Jobs page and link it to monitoring page. New images are included to better explanation

image
image

How was this patch tested?

This pull request contains only documentation. I have generated it using "jekyll build" to ensure that it's ok

@planga82 planga82 force-pushed the feature/SPARK-28543_ImproveWebUIDocs branch from 4747d3c to 14fbad7 Compare August 12, 2019 20:57
@dongjoon-hyun dongjoon-hyun changed the title [SPARK-28543][WebUI] Document Spark Jobs page [SPARK-28543][DOCS][WebUI] Document Spark Jobs page Aug 12, 2019
@dongjoon-hyun
Copy link
Member

ok to test

@planga82
Copy link
Contributor Author

image
image

@dongjoon-hyun
Copy link
Member

Thank you for your contribution, @planga82 .

@SparkQA
Copy link

SparkQA commented Aug 12, 2019

Test build #108999 has finished for PR 25424 at commit 14fbad7.

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

Copy link
Member

@srowen srowen left a comment

Choose a reason for hiding this comment

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

I'm not against this, but it's mostly repeating what's written on the UI page and in tooltips. How much does this add?

docs/web-ui.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

spark -> Spark (and below)

docs/web-ui.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

starts -> started

docs/web-ui.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Remove parentheses, or just say "See [job scheduling]"

docs/web-ui.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

id -> ID

docs/web-ui.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Remove the "The information we could find is:"

docs/web-ui.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

RDDs or DataFrames

docs/web-ui.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Id -> ID

@planga82
Copy link
Contributor Author

Thanks for the review @srowen , I have fixed all comments
About your first question, sure, it doesn't add too much. When I saw the Jira issue I thought about how to drive it. I think it's a good idea to have documentation about the web UI but I don't know what kind of documentation. Do you think it's better to add some examples? or explain what is a Job... but I think it's not the best place to explain what is a Job. Any idea to improve it?

@SparkQA
Copy link

SparkQA commented Aug 13, 2019

Test build #109058 has finished for PR 25424 at commit 23d9fe7.

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

@srowen
Copy link
Member

srowen commented Aug 13, 2019

Yeah I don't know right now. Maybe OK to just get a basic page down in the docs.

@zhengruifeng
Copy link
Contributor

@srowen I had some offline discussion with @gatorsmile , and the expected doc seems to be something like
1, https://www.cloudera.com/documentation/enterprise/5-9-x/topics/operation_spark_applications.html#spark_monitoring
2, https://www.ibm.com/support/knowledgecenter/en/SS3H8V_1.1.0/com.ibm.izoda.v1r1.azka100/topics/azkic_c_webUIs.htm

the first step in my opinion is to add some basic explanation, example and figure for each tab, and we can refine it in the future.

@srowen
Copy link
Member

srowen commented Aug 15, 2019

Merged to master

@srowen srowen closed this in 3f35440 Aug 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

Comments