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

[YUNIKORN-2969] fix inconsistent layout in REST documentation #510

Closed
wants to merge 2 commits into from
Closed

[YUNIKORN-2969] fix inconsistent layout in REST documentation #510

wants to merge 2 commits into from

Conversation

ryankert01
Copy link
Contributor

What is this PR for?

The REST scheduler page is really inconsistent when you look at the side bar that is generated by the system.

  • Some calls have a subheader without text, like Nodes and Node as an example
  • User and group tracker seem to have part of the description in the side bar
  • Application and queue side bar has multiple issues with duplicate descriptions and sub grouping that does not seem correct.

What type of PR is it?

  • - Bug Fix
  • - Improvement
  • - Feature
  • - Documentation
  • - Hot Fix
  • - Refactoring

Todos

  • - Task

What is the Jira issue?

https://issues.apache.org/jira/browse/YUNIKORN-2969

How should this be tested?

Screenshots (if appropriate)

截圖 2024-12-23 下午5 01 57
截圖 2024-12-23 下午5 01 53
截圖 2024-12-23 下午5 01 45
截圖 2024-12-23 下午5 01 38

Questions:

  • - The licenses files need update.
  • - There is breaking changes for older versions.
  • - It needs documentation.

wilfred-s
wilfred-s requested changes Dec 24, 2024
View reviewed changes
Copy link
Contributor

@wilfred-s wilfred-s left a comment

Choose a reason for hiding this comment

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

Change for user and group quota headings:

  • UsersTracker should become User quota and usage (level ##)
  • Get users usage tracking information should become All users level ###)
  • Get specific user usage tracking information should become Single user (level ###)
  • GroupsTracker should be Group quota and usage (level ##)
  • Get groups usage tracking information should become All groups level ###)
  • Get specific group usage tracking information should become Single group (level ###)

docs/api/scheduler.md Outdated

**Code** : `500 Internal Server Error`

## UserTracker
### Get specific user usage tracking information
Fetch specific user usage given a Partition and displays general information about the users managed by YuniKorn. In case the username contains any special characters, it needs to be url escaped to avoid issues.
Copy link
Contributor

Choose a reason for hiding this comment

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

Replace text with:
Fetch the specified user given a Partition and displays usage and quota information for the user. All queues in the hierarchy tracking the user will be included.

Same kind of change for all users, replace text with:
Fetch all user given a Partition and displays usage and quota information for the users. All queues in the hierarchy tracked for the specific user will be included.

Similar text change for group, based on the user change.
Similar text change for groups, based on the users change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done.

docs/api/scheduler.md
@@ -1086,7 +1086,7 @@ Fetch all groups usage given a Partition and displays general information about
]
```

### Error response
#### Error response

**Code** : `500 Internal Server Error`

Copy link
Contributor

Choose a reason for hiding this comment

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

Group tracker (next line 1093) should be updated the same way as the user tracker is updated

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done.

@ryankert01
Copy link
Contributor Author

ryankert01 commented Dec 24, 2024 •
edited
Loading

@wilfred-s Thanks for your review. It looks a lot cleaner now!

截圖 2024-12-24 下午4 06 31

chenyulin0719
chenyulin0719 approved these changes Dec 30, 2024
View reviewed changes
Copy link
Contributor

@chenyulin0719 chenyulin0719 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

github-actions bot pushed a commit that referenced this pull request Jan 4, 2025
@yunikorn-bot
Auto refresh: [YUNIKORN-2969] fix inconsistent layout in REST documen…
baa8cac 
…tation (#510)
@ryankert01 ryankert01 deleted the YUNIKORN-2969 branch January 12, 2025 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chenyulin0719 chenyulin0719 chenyulin0719 approved these changes

@manirajv06 manirajv06 Awaiting requested review from manirajv06

@wilfred-s wilfred-s Awaiting requested review from wilfred-s

@pbacsko pbacsko Awaiting requested review from pbacsko

Assignees

@ryankert01 ryankert01

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ryankert01 @wilfred-s @chenyulin0719