Skip to content

Commit

Permalink
Auto refresh: [YUNIKORN-2288] Encourage user to run e2e by run-e2e-te…
Browse files Browse the repository at this point in the history 
…sts.sh instead of make e2e_test in doc (apache#386)
  • Loading branch information
@yunikorn-bot
yunikorn-bot committed Jan 2, 2024
1 parent e780853 commit f505e72
Show file tree
Hide file tree
Showing 1,111 changed files with 4,421 additions and 4,421 deletions.
10 changes: 5 additions & 5 deletions 404.html
View file

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion assets/js/229fac93.5b514ca1.js
View file

This file was deleted.

1 change: 1 addition & 0 deletions assets/js/229fac93.a17be03d.js
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions assets/js/main.d8dac877.js → assets/js/main.c87a5847.js
View file

Large diffs are not rendered by default.

0 assets/js/main.d8dac877.js.LICENSE.txt → assets/js/main.c87a5847.js.LICENSE.txt
View file
File renamed without changes.
2 changes: 1 addition & 1 deletion assets/js/runtime~main.1738bd2c.js → assets/js/runtime~main.7ff8ac0b.js
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions community/coding_guidelines/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.1">
<title data-rh="true">Coding Guidelines | Apache YuniKorn</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://yunikorn.apache.org/img/logo/yunikorn-logo-main.png"><meta data-rh="true" name="twitter:image" content="https://yunikorn.apache.org/img/logo/yunikorn-logo-main.png"><meta data-rh="true" property="og:url" content="https://yunikorn.apache.org/community/coding_guidelines"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Coding Guidelines | Apache YuniKorn"><meta data-rh="true" name="description" content="&lt;!--"><meta data-rh="true" property="og:description" content="&lt;!--"><link data-rh="true" rel="icon" href="/img/yunikorn.ico"><link data-rh="true" rel="canonical" href="https://yunikorn.apache.org/community/coding_guidelines"><link data-rh="true" rel="alternate" href="https://yunikorn.apache.org/community/coding_guidelines" hreflang="en"><link data-rh="true" rel="alternate" href="https://yunikorn.apache.org/zh-cn/community/coding_guidelines" hreflang="zh-cn"><link data-rh="true" rel="alternate" href="https://yunikorn.apache.org/community/coding_guidelines" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://Q1V951BG2V-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Apache YuniKorn" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.056372a5.css">
<link rel="preload" href="/assets/js/runtime~main.1738bd2c.js" as="script">
<link rel="preload" href="/assets/js/main.d8dac877.js" as="script">
<link rel="preload" href="/assets/js/runtime~main.7ff8ac0b.js" as="script">
<link rel="preload" href="/assets/js/main.c87a5847.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus">
Expand Down Expand Up @@ -40,12 +40,12 @@
There are three tabs to configure, the first two are crucial to comply with the basic rules from <code>gofmt</code> and <code>goimports</code>:</p><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Tabs</td><td><img loading="lazy" alt="tabs" src="/assets/images/goland_ide_pref_tabs-35f887a9c67980c3a703b2463d869dba.png" width="605" height="328" class="img_ev3q"></td></tr><tr><td>Imports</td><td><img loading="lazy" alt="imports" src="/assets/images/goland_ide_pref_imports-853b75298463f39a6cdffb70a1228a5e.png" width="601" height="438" class="img_ev3q"></td></tr><tr><td>Other</td><td><img loading="lazy" alt="other" src="/assets/images/goland_ide_pref_other-f4969d5ecf1ad8a61e727cf4b93164e1.png" width="684" height="387" class="img_ev3q"></td></tr></tbody></table><p>The imports as configured above should create 3 groups of imports in a file when they are used:</p><ol><li>standard library imports</li><li>third-party imports</li><li>YuniKorn internal imports</li></ol><p>In the file it will give you an import that looks like this:</p><div class="language-go codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-go codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token keyword" style="font-style:italic">import</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">// standard libraries</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">// third-party</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">// YuniKorn project imports</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="inspections">Inspections<a href="#inspections" class="hash-link" aria-label="Direct link to Inspections" title="Direct link to Inspections">​</a></h3><p>The default inspections can be used except for one that helps highlight shadowing variables.
Shadowing can cause difficult to trace and obscure bugs in the code and should be prevented whenever possible. </p><p><img loading="lazy" alt="inspections" src="/assets/images/goland_ide_pref_inspections-808d7022dc77eb23848adcea32557746.png" width="930" height="552" class="img_ev3q"></p></article></div><div class="col col--2"><div class="tableOfContents_bqdL thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#the-basics" class="table-of-contents__link toc-highlight">The basics</a></li><li><a href="#automated-checks" class="table-of-contents__link toc-highlight">Automated checks</a><ul><li><a href="#installing-and-running-locally" class="table-of-contents__link toc-highlight">Installing and running locally</a></li><li><a href="#configuration" class="table-of-contents__link toc-highlight">Configuration</a></li><li><a href="#integration-in-pull-requests" class="table-of-contents__link toc-highlight">Integration in pull requests</a></li></ul></li><li><a href="#false-positives" class="table-of-contents__link toc-highlight">False positives</a></li><li><a href="#goland-ide-setup" class="table-of-contents__link toc-highlight">GoLand IDE setup</a><ul><li><a href="#editor-preferences" class="table-of-contents__link toc-highlight">Editor preferences</a></li><li><a href="#inspections" class="table-of-contents__link toc-highlight">Inspections</a></li></ul></li></ul></div></div></div></main></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Blog</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://blog.cloudera.com/yunikorn-a-universal-resources-scheduler/" target="_blank" rel="noopener noreferrer" class="footer__link-item">What&#x27;s YuniKorn?<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://blog.cloudera.com/spark-on-kubernetes-gang-scheduling-with-yunikorn/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Spark on Kubernetes – Gang Scheduling with YuniKorn<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">Code Repositories</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/apache/yunikorn-core/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Core scheduler<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/apache/yunikorn-k8shim" target="_blank" rel="noopener noreferrer" class="footer__link-item">Kubernetes shim<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/apache/yunikorn-scheduler-interface" target="_blank" rel="noopener noreferrer" class="footer__link-item">Scheduler Interface<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/apache/yunikorn-web" target="_blank" rel="noopener noreferrer" class="footer__link-item">WEB application<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/apache/yunikorn-site" target="_blank" rel="noopener noreferrer" class="footer__link-item">Website<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/community/get_involved">Get Involved</a></li><li class="footer__item"><a class="footer__link-item" href="/community/community/people">People</a></li><li class="footer__item"><a href="https://issues.apache.org/jira/projects/YUNIKORN/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">Issues<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div style="font-size: 70%">
Copyright © 2020-2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>. <br>
Copyright © 2020-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>. <br>
<div style="padding:20px; margin: 10px; color: #4d4d4d;">
<p>The Apache Software Foundation Apache YuniKorn, YuniKorn, Apache, the Apache feather, and the Apache YuniKorn project logo are either registered trademarks or trademarks of the Apache Software Foundation.</p>
</div>
</div></div></div></div></footer></div>
<script src="/assets/js/runtime~main.1738bd2c.js"></script>
<script src="/assets/js/main.d8dac877.js"></script>
<script src="/assets/js/runtime~main.7ff8ac0b.js"></script>
<script src="/assets/js/main.c87a5847.js"></script>
</body>
</html>
Loading

0 comments on commit f505e72

Please sign in to comment.