[
https://issues.apache.org/jira/browse/YUNIKORN-395?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17189379#comment-17189379
]
Adam Antal commented on YUNIKORN-395:
-------------------------------------
Regarding the scheduler core repo:
The following documents are exactly the same in the website:
- community/ coding_guidelines.md, reporting-issues.md, how-to-contribute.md
- design/ cross-queue-preemption.md, namespace-resource-quota.md,
pluggable-app-management.md, resilience.md, scheduler-configuration.md,
scheduler-object-states.md
- developer_guide/ env-setup.md
- performance/ metrics.md, profiling.md, evalute-perf-function-with-Kubemark.md
- user_guide/ acls.md, sorting-policy.md
The following docs haver an updated version in the website, so the outdated
ones in the core can be safely deleted:
- community/ roadmap.md
- design/ scheduler-core-design.md, state-aware-scheduling.md
- developer_guide/ deployment.md
The following changes are also made between the two set of docs (but the
content is kept!):
- community-sync-up.md has been merged into get_involved.md
- build-local.md has been merged into build.md
- configure-scheduler.md has been merged into deployment.md
And those places that I found that the website does not contain:
- user_guide/ queue-config.md has been updated with node sorting policy and
some other things in YUNIKORN-99. I wonder whether we need this. [~wilfreds]
could you check it?
- There have been added multiple helm chart parameters into user-guide.md, but
this is not reflected in the website. [~kmarton] as you've changed this, could
you please check if we need the change? The corresponding issue is YUNIKORN-245.
Note:
Currently we don't have these pieces (but they're also quite old code) in the
core, starting from
[this|https://github.com/apache/incubator-yunikorn-core/blob/master/docs/user-guide.md#run-workloads-with-yunikorn-scheduler]
chapter. I think we can just simply skip this.
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.
At the bottom of the developer-guide.md there's a chapter that's missing from
the website: "Core component build"
([link|https://github.com/apache/incubator-yunikorn-core/blob/master/docs/developer-guide.md#core-component-build]).
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 pushed a [draft
PR|https://github.com/apache/incubator-yunikorn-core/pull/202] for this change,
where I did not remove the parts above where we still need some discussion. If
you have time, please check those items.
> 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: [email protected]
For additional commands, e-mail: [email protected]
