mirror of https://github.com/istio/istio.io.git
2 lines
14 KiB
HTML
2 lines
14 KiB
HTML
<!DOCTYPE html><html lang="en" itemscope itemtype="https://schema.org/WebPage"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="theme-color" content="#466BB0"/><meta name="title" content="Creating a Pull Request"><meta name="description" content="Shows you how to create a GitHub pull request in order to submit your docs for approval."><meta name="og:title" content="Creating a Pull Request"><meta name="og:description" content="Shows you how to create a GitHub pull request in order to submit your docs for approval."><meta name="og:url" content="/about/contribute/creating-a-pull-request.html"><meta name="og.site_name" content="Istio"><title>Istioldie 0.6 / Creating a Pull Request</title><script> window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; ga('create', 'UA-98480406-2', 'auto'); ga('send', 'pageview'); </script> <script async src='https://www.google-analytics.com/analytics.js'></script><link rel="alternate" type="application/rss+xml" title="Istio Blog RSS" href="/v0.6/feed.xml"><link rel="shortcut icon" href="/v0.6/favicons/favicon.ico" ><link rel="apple-touch-icon" href="/v0.6/favicons/apple-touch-icon-180x180.png" sizes="180x180"><link rel="icon" type="image/png" href="/v0.6/favicons/favicon-16x16.png" sizes="16x16"><link rel="icon" type="image/png" href="/v0.6/favicons/favicon-32x32.png" sizes="32x32"><link rel="icon" type="image/png" href="/v0.6/favicons/android-36x36.png" sizes="36x36"><link rel="icon" type="image/png" href="/v0.6/favicons/android-48x48.png" sizes="48x48"><link rel="icon" type="image/png" href="/v0.6/favicons/android-72x72.png" sizes="72x72"><link rel="icon" type="image/png" href="/v0.6/favicons/android-96x196.png" sizes="96x196"><link rel="icon" type="image/png" href="/v0.6/favicons/android-144x144.png" sizes="144x144"><link rel="icon" type="image/png" href="/v0.6/favicons/android-192x192.png" sizes="192x192"><link rel="manifest" href="/v0.6/manifest.json"><meta name="apple-mobile-web-app-title" content="Istio"><meta name="application-name" content="Istio"><link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic"><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous"><link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.6/css/all.css"><link rel="stylesheet" href="/v0.6/css/light_theme.css" title="light"><link rel="alternate stylesheet" href="/v0.6/css/dark_theme.css" title="dark"> <script src="/v0.6/js/styleSwitcher.min.js"></script></head><body class="language-unknown theme-unknown"><header role="banner"><nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark"> <a class="navbar-brand" href="/v0.6/" style="visibility: visible"> <img class="logo" src="/v0.6/img/istio-logo.svg" alt="Istio Logo"/> <span class="brand-name">Istioldie 0.6</span> </a> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse" aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button><div class="collapse navbar-collapse justify-content-end" id="navbarCollapse"><ul class="navbar-nav"><li class="nav-item"> <a class="nav-link active" href="/v0.6/about/intro.html">About</a></li><li class="nav-item"> <a class="nav-link " href="/v0.6/blog/2018/traffic-mirroring.html">Blog</a></li><li class="nav-item"> <a class="nav-link " href="/v0.6/docs/">Docs</a></li><li class="nav-item"> <a class="nav-link " href="/v0.6/help/">Help</a></li><li class="nav-item"> <a class="nav-link " href="/v0.6/community.html">Community</a></li><li class="nav-item dropdown" id="gearDropdown" style="white-space: nowrap"> <a href="" class="nav-link dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> <i style="width: 1em" class='fa fa-lg fa-cog'></i> </a><ul class="dropdown-menu" aria-labelledby="gearDropdown"><h6 class="dropdown-header">Other versions of this site</h6><li> <a href="https://istio.io">Current Release</a></li><li> <a href="https://preliminary.istio.io">Next Release</a></li><li> <a href="https://archive.istio.io">Older Releases</a></li><li class="dropdown-divider"></li><li> <i class='fa fa-check light'></i> <a href="" onclick="setActiveStyleSheet('light');return false;">Light Theme</a></li><li> <i class='fa fa-check dark'></i> <a href="" onclick="setActiveStyleSheet('dark');return false;">Dark Theme</a></li></ul></li></ul><form name="cse" id="searchbox" class="form-inline justify-content-end" role="search"> <input type="hidden" name="cx" value="013699703217164175118:iwwf17ikgf4" /> <input type="hidden" name="ie" value="utf-8" /> <input type="hidden" name="hl" value="en" /><div class="input-group"> <input name="q" class="form-control search-box" type="text" size="30" /> <button class="btn btn-search input-group-addon my-2 my-sm-0 fa fa-search" type="submit"></button></div></form></div></nav></header><div class="container-fluid"><div class="row row-offcanvas row-offcanvas-left"><div class="col-6 col-md-3 col-xl-2 sidebar-offcanvas"><nav class="sidebar"><div class="spacer"></div><div class="directory" role="tablist"><div class="card"><div class="card-header" role="tab" id="header0"><div title="All about Istio."> About Istio</div></div><div id="collapse0" class="collapse show" data-parent="#sidebar" role="tabpanel" aria-labelledby="header0"><div class="card-body"><ul class="tree"><li> <a title="Context about what problems Istio is designed to solve." href="/v0.6/about/intro.html">What is Istio?</a></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Istio releases information." href="/v0.6/about/notes">Release Notes</a> </label><ul class="tree collapse"><li> <a title="" href="/v0.6/about/notes/0.6.html">Istio 0.6</a></li><li> <a title="" href="/v0.6/about/notes/0.5.html">Istio 0.5</a></li><li> <a title="" href="/v0.6/about/notes/0.4.html">Istio 0.4</a></li><li> <a title="" href="/v0.6/about/notes/0.3.html">Istio 0.3</a></li><li> <a title="" href="/v0.6/about/notes/0.2.html">Istio 0.2</a></li><li> <a title="" href="/v0.6/about/notes/0.1.html">Istio 0.1</a></li></ul></li><li> <a title="List of features and their release stages." href="/v0.6/about/feature-stages.html">Feature Status</a></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-down'></i> <a class="" title="Learn how to contribute to improve and expand the Istio documentation." href="/v0.6/about/contribute">Contributing to the Docs</a> </label><ul class="tree"><li> <a title="Lets you start editing this site's documentation." href="/v0.6/about/contribute/editing.html">Editing Docs</a></li><li> <span class="current" title="Shows you how to create a GitHub pull request in order to submit your docs for approval.">Creating a Pull Request</span></li><li> <a title="Explains the mechanics of creating new documentation pages." href="/v0.6/about/contribute/writing-a-new-topic.html">Writing a New Topic</a></li><li> <a title="Explains how to test your changes locally before submitting them." href="/v0.6/about/contribute/staging-your-changes.html">Staging Your Changes</a></li><li> <a title="Explains the process involved in accepting documentation updates." href="/v0.6/about/contribute/reviewing-doc-issues.html">Doc Issues</a></li><li> <a title="Explains the dos and donts of writing Istio docs." href="/v0.6/about/contribute/style-guide.html">Style Guide</a></li></ul></div></div></div></div></nav></div><div class="col-12 col-md-9 col-lg-7 col-xl-8"><p class="d-md-none"> <label class="sidebar-toggler" data-toggle="offcanvas"> <i class="fa fa-chevron-right"></i> </label></p><main role="main"><h1>Creating a Pull Request</h1><p>To contribute to Istio documentation, create a pull request against the <a href="https://github.com/istio/istio.github.io" target="_blank">istio/istio.github.io</a> repository. This page shows the steps necessary to create a pull request.</p><h2 id="before-you-begin">Before you begin</h2><ol><li><p>Create a <a href="https://github.com" target="_blank">GitHub account</a>.</p></li><li><p>Sign the <a href="https://github.com/istio/community/blob/master/CONTRIBUTING.md#contributor-license-agreements">Contributor License Agreement</a></p></li></ol><p>Documentation will be published under the <a href="https://github.com/istio/istio.github.io/blob/master/LICENSE">Apache 2.0</a> license.</p><h2 id="creating-a-fork">Creating a fork</h2><p>Before you can edit documentation, you need to create a fork of Istio’s documentation GitHub repository:</p><ol><li><p>Go to the <a href="https://github.com/istio/istio.github.io" target="_blank">istio/istio.github.io</a> repository.</p></li><li><p>In the upper-right corner, click <strong>Fork</strong>. This creates a copy of Istio’s documentation repository in your GitHub account. The copy is called a <em>fork</em>.</p></li></ol><h2 id="making-your-changes">Making your changes</h2><ol><li><p>In your GitHub account, in your fork of the Istio repository, create a new branch to use for your contribution.</p></li><li><p>In your new branch, make your changes and commit them. If you want to <a href="./writing-a-new-topic.html">write a new topic</a>, choose the <a href="./writing-a-new-topic.html#choosing-a-page-type">page-type</a> that is the best fit for your content.</p></li></ol><h2 id="submitting-a-pull-request">Submitting a pull request</h2><p>To publish your changes, you must create a pull request against the master branch of Istio’s documentation repository.</p><ol><li><p>Make sure your change produce valid html and links are valid, <code class="highlighter-rouge">rake test</code> will check this for you.</p></li><li><p>In your GitHub account, in your new branch, create a pull request against the master branch of the istio/istio.github.io repository. This opens a page that shows the status of your pull request.</p></li><li><p>During the next few days, check your pull request for reviewer comments. If needed, revise your pull request by committing changes to your new branch in your fork.</p></li></ol></main></div><div class="col-12 col-md-2 d-none d-lg-block"><nav class="toc"><div class="spacer"></div><div class="directory" role="directory"><ul><li><a href="#before-you-begin">Before you begin</a></li><li><a href="#creating-a-fork">Creating a fork</a></li><li><a href="#making-your-changes">Making your changes</a></li><li><a href="#submitting-a-pull-request">Submitting a pull request</a></li></ul></div></nav></div></div></div><div class="footer"><footer><div class="container-fluid"><div class="row"><div class="col-sm-2"></div><nav class=" col-12 col-sm-3" role="navigation"><ul class="first"><li><a class="header" href="/v0.6/docs/">Docs</a></li><li><a href="/v0.6/docs/concepts/">Concepts</a></li><li><a href="/v0.6/docs/setup/">Setup</a></li><li><a href="/v0.6/docs/tasks/">Tasks</a></li><li><a href="/v0.6/docs/guides/">Guides</a></li><li><a href="/v0.6/docs/reference/">Reference</a></li></ul></nav><nav class="col-12 col-sm-3" role="navigation"><ul><li><a class="header" href="/v0.6/help/">Help</a></li><li><a href="/v0.6/help/faq/index.html">FAQ</a></li><li><a href="/v0.6/help/glossary.html">Glossary</a></li><li><a href="/v0.6/help/troubleshooting.html">Troubleshooting</a></li><li><a href="/v0.6/help/bugs.html">Report Bugs</a></li><li><a href="https://github.com/istio/istio.github.io/issues/new?title=Issue with _about/contribute/creating-a-pull-request.md" target="_blank" rel="noopener">Doc Bugs & Gaps</a></li><li><a href="https://github.com/istio/istio.github.io/edit/master/_about/contribute/creating-a-pull-request.md" target="_blank" rel="noopener">Edit This Page</a></li></ul></nav><nav class="col-12 col-sm-3" role="navigation"><ul><li><a class="header" href="/v0.6/community.html">Community</a></li><li> <a href="https://groups.google.com/forum/#!forum/istio-users" target="_blank" rel="noopener">User</a> | <a href="https://groups.google.com/forum/#!forum/istio-dev" target="_blank" rel="noopener">Dev Mailing Lists</a></li><li><a href="https://twitter.com/IstioMesh" target="_blank" rel="noopener">Twitter</a></li><li><a href="https://stackoverflow.com/questions/tagged/istio" target="_blank" rel="noopener">Stack Overflow</a></li><li><a href="https://github.com/istio/community/" target="_blank" rel="noopener">GitHub</a></li><li><a href="https://github.com/istio/community/blob/master/WORKING-GROUPS.md" target="_blank" rel="noopener">Working Groups</a></li></ul></nav></div><div class="row"><div class="col-12"><p class="description text-center" role="contentinfo"> Istio Archive 0.6, Copyright © 2018 Istio Authors<br> Archived on 02-Apr-2018</p></div></div></div></footer></div><script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js" integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q" crossorigin="anonymous"></script> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script> <script src="https://www.google.com/cse/brand?form=searchbox"></script> <script src="/v0.6/js/misc.min.js"></script></body></html>
|