YARN-11444. Improve YARN md documentation format. #5431
Closed
Conversation
This file contains 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
|
🎊 +1 overall
This message was automatically generated. |
|
🎊 +1 overall
This message was automatically generated. |
|
@ayushtkn Can you help review this pr? Thank you very much! |
ayushtkn
requested changes
Apr 19, 2023
There was a problem hiding this comment.
Couldn't check line by line. It is huge.......
I doubt the numbering stuff, putting 1. is the md files automatically sort the numbering. If not pass me the links on every change from here, where it is unsorted.
http://apache.github.io/hadoop
Spacing changes, I couldn't figure out either, you need to attach screenshots so that folks can figure out what is the impact of having those spaces.
Hope you have built the website locally and checked nothing on those pages is getting broken either
Comment on lines
141
to
+142
| The above code shows the `DevicePluginScheduler` interface that you might | ||
| needed if you want to arm the plugin with a more efficient scheduler. | ||
| be needed if you want to arm the plugin with a more efficient scheduler. |
There was a problem hiding this comment.
does this sound better?
The above code shows the you might need `DevicePluginScheduler` interface if you want to arm the plugin with a more efficient scheduler.
Comment on lines
-62
to
+78
| 1. It works in both secure and non secure clusters. | ||
| 1. The generic history service is built on the timeline store. | ||
| 1. The history can be stored in memory or in a leveldb database store; | ||
| 2. It works in both secure and non secure clusters. | ||
| 3. The generic history service is built on the timeline store. | ||
| 4. The history can be stored in memory or in a leveldb database store; | ||
| the latter ensures the history is preserved over Timeline Server restarts. | ||
| 1. The ability to install framework specific UIs in YARN is not supported. | ||
| 1. Application specific information is only available via RESTful APIs using JSON type content. | ||
| 1. The "Timeline Server v1" REST API has been declared one of the REST APIs | ||
| 5. The ability to install framework specific UIs in YARN is not supported. | ||
| 6. Application specific information is only available via RESTful APIs using JSON type content. | ||
| 7. The "Timeline Server v1" REST API has been declared one of the REST APIs | ||
| whose compatibility will be maintained in future releases. | ||
| 1. The single-server implementation of the Timeline Server places a limit on | ||
| 8. The single-server implementation of the Timeline Server places a limit on | ||
| the scalability of the service; it also prevents the service being | ||
| High-Availability component of the YARN infrastructure. | ||
|
|
||
| Future Plans | ||
|
|
||
| 1. Future releases will introduce a next generation timeline service | ||
| which is scalable and reliable, ["Timeline Service v2"](./TimelineServiceV2.html). | ||
| 1. The expanded features of this service *may not* be available to | ||
| 2. The expanded features of this service *may not* be available to |
There was a problem hiding this comment.
this sounds correct only, the numbering is correct only
http://apache.github.io/hadoop/hadoop-yarn/hadoop-yarn-site/TimelineServer.html
Comment on lines
-836
to
+842
| 1. `limit` - A limit on the number of events to return for each entity. If null, | ||
| 2. `limit` - A limit on the number of events to return for each entity. If null, | ||
| defaults to 100 events per entity. | ||
| 1. `windowStart` - If not null, retrieves only events later than the given time | ||
| 3. `windowStart` - If not null, retrieves only events later than the given time | ||
| (exclusive) | ||
| 1. `windowEnd` - If not null, retrieves only events earlier than the given time | ||
| 4. `windowEnd` - If not null, retrieves only events earlier than the given time | ||
| (inclusive) | ||
| 1. `eventType` - Restricts the events returned to the given types. If null, | ||
| 5. `eventType` - Restricts the events returned to the given types. If null, |
There was a problem hiding this comment.
I doubt if this is required. Pass me the link from here where it shows messed up
http://apache.github.io/hadoop
| * **A queuePlacementPolicy element**: which contains a list of rule elements that tell the scheduler how to place incoming apps into queues. Rules are applied in the order that they are listed. Rules may take arguments. All rules accept the "create" argument, which indicates whether the rule can create a new queue. "Create" defaults to true; if set to false and the rule would place the app in a queue that is not configured in the allocations file, we continue on to the next rule. The last rule must be one that can never issue a continue. Valid rules are: | ||
| * **A queuePlacementPolicy element**: which contains a list of rule elements that tell the scheduler how to place incoming apps into queues. Rules are applied in the order that they are listed. Rules may take arguments. All rules accept the "create" argument, which indicates whether the rule can create a new queue. "Create" defaults to true; if set to false and the rule would place the app in a queue that is not configured in the allocations file, we continue on to the next rule. The last rule must be one that can never issue a continued. Valid rules are: |
There was a problem hiding this comment.
continue to continued?Is that a command which is continued but not continue, can you pass me the link to that?
|
🎊 +1 overall
This message was automatically generated. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
JIRA: YARN-11444. Improve YARN md documentation format.
When reading the md file locally, I encountered format problems and it was not easy to read. I think we should align the columns
Not easy to read, not easy to modify