You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@yunikorn.apache.org by "Weiwei Yang (Jira)" <ji...@apache.org> on 2020/09/02 20:29:00 UTC

[jira] [Comment Edited] (YUNIKORN-395) Clean up the old docs in core/shim/web/scheduler-interface repos

    [ https://issues.apache.org/jira/browse/YUNIKORN-395?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17189697#comment-17189697 ] 

Weiwei Yang edited comment on YUNIKORN-395 at 9/2/20, 8:28 PM:
---------------------------------------------------------------

hi [~adam.antal]

Thanks for working on this.
I've merged the PR for the scheduler-interface and the shim, which are simple and straightforward.
For the core side changes, thanks for identifying the issues, see my comments below:

{quote}
user_guide/ queue-config.md has been updated with node sorting policy and some other things in YUNIKORN-99. 
{quote}

That seems like the thing we are missing in the web-site, could you please update them to the website docs?

{quote}
There have been added multiple helm chart parameters into user-guide.md, but this is not reflected in the website.
{quote}

We need to add these things back. I think we need to create another doc to cover advanced installation options. Not in the Get-Started guide, it can be the first doc under User Guide section. [~kmarton], would you like to work on this part?

{quote}
Currently we don't have these pieces (but they're also quite old code) in the core, starting from this chapter. I think we can just simply skip this.
{quote}

They are quite outdated, we can safely remove them. The counterpart for this is: http://yunikorn.apache.org/docs/next/user_guide/workloads.

{quote}
Also all assets (images) are verified to be incorporated already in the website, so they can be safely deleted if not used somewhere else in the scheduler.
{quote}

Yes, I think so. The only exception is the assets used in the README doc, e.g the logo png files.

{quote}
At the bottom of the developer-guide.md there's a chapter that's missing from the website: "Core component build" (link). I don't know what should we do with it. It can be kept in the core as it is very core related, but keeping just that in the core does not really make sense.
{quote}

I think we can leave it in the README of the core repo. 



was (Author: wwei):
hi [~adam.antal]

Thanks for working on this.
I've merged the PR for the scheduler-interface and the shim, which are simple and straightforward.
For the core side changes, thanks for identifying the issues, see my comments below:

> user_guide/ queue-config.md has been updated with node sorting policy and some other things in YUNIKORN-99. 

That seems like the thing we are missing in the web-site, could you please update them to the website docs?

> There have been added multiple helm chart parameters into user-guide.md, but this is not reflected in the website.

We need to add these things back. I think we need to create another doc to cover advanced installation options. Not in the Get-Started guide, it can be the first doc under User Guide section. [~kmarton], would you like to work on this part?

> Currently we don't have these pieces (but they're also quite old code) in the core, starting from this chapter. I think we can just simply skip this.

They are quite outdated, we can safely remove them. The counterpart for this is: http://yunikorn.apache.org/docs/next/user_guide/workloads.

> Also all assets (images) are verified to be incorporated already in the website, so they can be safely deleted if not used somewhere else in the scheduler.

Yes, I think so. The only exception is the assets used in the README doc, e.g the logo png files.

> At the bottom of the developer-guide.md there's a chapter that's missing from the website: "Core component build" (link). I don't know what should we do with it. It can be kept in the core as it is very core related, but keeping just that in the core does not really make sense.

I think we can leave it in the README of the core repo. 


> Clean up the old docs in core/shim/web/scheduler-interface repos
> ----------------------------------------------------------------
>
>                 Key: YUNIKORN-395
>                 URL: https://issues.apache.org/jira/browse/YUNIKORN-395
>             Project: Apache YuniKorn
>          Issue Type: Sub-task
>          Components: core - common, scheduler-interface, shim - kubernetes, webapp
>            Reporter: Weiwei Yang
>            Assignee: Adam Antal
>            Priority: Major
>              Labels: pull-request-available
>
> Since we have moved all docs to the website, we should remove all existing doc files in our repos. Please review all the docs, make sure they are moved to yunikorn-site repo, and then remove them from other repos.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@yunikorn.apache.org
For additional commands, e-mail: issues-help@yunikorn.apache.org