istio.io/archive/v1.8/about/contribute/github/index.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="Work with GitHub"><meta name=description content="Shows you how to use GitHub to contribute to the Istio documentation."><meta name=keywords content="microservices,services,mesh,contribute,community,github,pr"><meta property="og:title" content="Work with GitHub"><meta property="og:type" content="website"><meta property="og:description" content="Shows you how to use GitHub to contribute to the Istio documentation."><meta property="og:url" content="/v1.8/about/contribute/github/"><meta property="og:image" content="/v1.8/img/istio-whitelogo-bluebackground-framed.svg"><meta property="og:image:alt" content="Istio Logo"><meta property="og:image:width" content="112"><meta property="og:image:height" content="150"><meta property="og:site_name" content="Istio"><meta name=twitter:card content="summary"><meta name=twitter:site content="@IstioMesh"><title>Istioldie 1.8 / Work with GitHub</title><script async src="https://www.googletagmanager.com/gtag/js?id=UA-98480406-2"></script><script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments);}
gtag('js',new Date());gtag('config','UA-98480406-2');</script><link rel=alternate type=application/rss+xml title="Istio Blog" href=/v1.8/blog/feed.xml><link rel=alternate type=application/rss+xml title="Istio News" href=/v1.8/news/feed.xml><link rel=alternate type=application/rss+xml title="Istio Blog and News" href=/v1.8/feed.xml><link rel="shortcut icon" href=/v1.8/favicons/favicon.ico><link rel=apple-touch-icon href=/v1.8/favicons/apple-touch-icon-180x180.png sizes=180x180><link rel=icon type=image/png href=/v1.8/favicons/favicon-16x16.png sizes=16x16><link rel=icon type=image/png href=/v1.8/favicons/favicon-32x32.png sizes=32x32><link rel=icon type=image/png href=/v1.8/favicons/android-36x36.png sizes=36x36><link rel=icon type=image/png href=/v1.8/favicons/android-48x48.png sizes=48x48><link rel=icon type=image/png href=/v1.8/favicons/android-72x72.png sizes=72x72><link rel=icon type=image/png href=/v1.8/favicons/android-96x96.png sizes=96xW96><link rel=icon type=image/png href=/v1.8/favicons/android-144x144.png sizes=144x144><link rel=icon type=image/png href=/v1.8/favicons/android-192x192.png sizes=192x192><link rel=manifest href=/v1.8/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=Work+Sans:400|Chivo:400|Work+Sans:500,300,600,300italic,400italic,500italic,600italic|Chivo:500,300,600,300italic,400italic,500italic,600italic"><link rel=stylesheet href=/v1.8/css/all.css><script src=/v1.8/js/themes_init.min.js></script></head><body class="language-unknown archive-site"><script>const branchName="release-1.8";const docTitle="Work with GitHub";const iconFile="\/v1.8/img/icons.svg";const buttonCopy='Copy to clipboard';const buttonPrint='Print';const buttonDownload='Download';</script><script src="https://www.google.com/cse/brand?form=search-form" defer></script><script src=/v1.8/js/all.min.js data-manual defer></script><header><nav><a id=brand href=/v1.8/><span class=logo><svg viewBox="0 0 300 300"><circle cx="150" cy="150" r="146" stroke-width="2"/><polygon points="65 240 225 240 125 270"/><polygon points="65 230 125 220 125 110"/><polygon points="135 220 225 230 135 30"/></svg></span><span class=name>Istioldie 1.8</span></a><div id=hamburger><svg class="icon hamburger"><use xlink:href="/v1.8/img/icons.svg#hamburger"/></svg></div><div id=header-links><a title="Learn how to deploy, use, and operate Istio." href=/v1.8/docs/>Docs</a>
<a title="Posts about using Istio." href=/v1.8/blog/2020/>Blog<i class=dot data-prefix=/blog></i></a>
<a title="Timely news about the Istio project." href=/v1.8/news/>News<i class=dot data-prefix=/news></i></a>
<a title="Frequently Asked Questions about Istio." href=/v1.8/faq/>FAQ</a>
<a class=current title="Get a bit more in-depth info about the Istio project." href=/v1.8/about/>About</a><div class=menu><button id=gearDropdownButton class=menu-trigger title="Options and settings" aria-label="Options and Settings" aria-controls=gearDropdownContent><svg class="icon gear"><use xlink:href="/v1.8/img/icons.svg#gear"/></svg></button><div id=gearDropdownContent class=menu-content aria-labelledby=gearDropdownButton role=menu><a tabindex=-1 role=menuitem lang=en id=switch-lang-en class=active>English</a>
<a tabindex=-1 role=menuitem lang=zh id=switch-lang-zh>中文</a><div role=separator></div><a tabindex=-1 role=menuitem class=active id=light-theme-item>Light Theme</a>
<a tabindex=-1 role=menuitem id=dark-theme-item>Dark Theme</a><div role=separator></div><a tabindex=-1 role=menuitem id=syntax-coloring-item>Color Examples</a><div role=separator></div><h6>Other versions of this site</h6><a tabindex=-1 role=menuitem onclick="navigateToUrlOrRoot('https://istio.io/about\/contribute\/github\/');return false;">Current Release</a>
<a tabindex=-1 role=menuitem onclick="navigateToUrlOrRoot('https://preliminary.istio.io/about\/contribute\/github\/');return false;">Next Release</a>
<a tabindex=-1 role=menuitem href=https://istio.io/archive>Older Releases</a></div></div><button id=search-show title="Search this site" aria-label=Search><svg class="icon magnifier"><use xlink:href="/v1.8/img/icons.svg#magnifier"/></svg></button></div><form id=search-form name=cse role=search><input type=hidden name=cx value=002184991200833970123:iwwf17ikgf4>
<input type=hidden name=ie value=utf-8>
<input type=hidden name=hl value=en>
<input type=hidden id=search-page-url value=/v1.8/search>
<input id=search-textbox class=form-control name=q type=search aria-label="Search this site">
<button id=search-close title="Cancel search" type=reset aria-label="Cancel search"><svg class="icon cancel-x"><use xlink:href="/v1.8/img/icons.svg#cancel-x"/></svg></button></form></nav></header><div class=banner-container></div><main class=primary><div id=sidebar-container class="sidebar-container sidebar-offcanvas"><nav id=sidebar aria-label="Section Navigation"><div class=directory><div class=card><div id=header0 class=header title="Get a bit more in-depth info about the Istio project."><svg class="icon about"><use xlink:href="/v1.8/img/icons.svg#about"/></svg>About Istio</div><div class="body default" aria-labelledby=header0><ul role=tree aria-expanded=true aria-labelledby=header0><li role=treeitem aria-label="Our Community"><button aria-hidden=true></button><a title="Learn about our community, our customers, and our partners." href=/v1.8/about/community/>Our Community</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Information on the various ways to participate and interact with the Istio community." href=/v1.8/about/community/join/>Getting Involved</a></li><li role=none><a role=treeitem title="Who's building stuff around Istio." href=/v1.8/about/community/partners/>Partners</a></li><li role=none><a role=treeitem title="Some of the companies that have adopted Istio." href=/v1.8/about/community/customers/>Who's using Istio</a></li></ul></li><li role=none><a role=treeitem title="List of features and their release stages." href=/v1.8/about/feature-stages/>Feature Status</a></li><li role=none><a role=treeitem title="How we manage, number, and support Istio releases." href=/v1.8/about/release-cadence/>Build & Release Cadence</a></li><li role=none><a role=treeitem title="What to do if you find a bug." href=/v1.8/about/bugs/>Reporting Bugs</a></li><li role=none><a role=treeitem title="How we handle security vulnerabilities." href=/v1.8/about/security-vulnerabilities/>Security Vulnerabilities</a></li><li role=none><a role=treeitem title="The currently supported Istio releases." href=/v1.8/about/supported-releases/>Supported Releases</a></li><li role=none><a role=treeitem title="Official Istio resources for digital and printed materials." href=/v1.8/about/media-resources/>Media Resources</a></li><li role=treeitem aria-label="Contribute Documentation"><button class=show aria-hidden=true></button><a title="Details how to create and maintain Istio documentation pages." href=/v1.8/about/contribute/>Contribute Documentation</a><ul role=group aria-expanded=true class=leaf-section><li role=none><span role=treeitem class=current title="Shows you how to use GitHub to contribute to the Istio documentation.">Work with GitHub</span></li><li role=none><a role=treeitem title="Details how to contribute new documentation to Istio." href=/v1.8/about/contribute/add-content/>Add New Documentation</a></li><li role=none><a role=treeitem title="Details how to contribute retired documentation to Istio." href=/v1.8/about/contribute/remove-content/>Remove Retired Documentation</a></li><li role=none><a role=treeitem title="Explains how to locally build, test, serve, and preview the website." href=/v1.8/about/contribute/build/>Build and serve the website locally</a></li><li role=none><a role=treeitem title="Explains the front matter used in our documentation and the fields available." href=/v1.8/about/contribute/front-matter/>Front matter</a></li><li role=none><a role=treeitem title="Shows you how changes to the Istio documentation and website are reviewed and approved." href=/v1.8/about/contribute/review/>Documentation Review Process</a></li><li role=none><a role=treeitem title="Explains how to include code in your documentation." href=/v1.8/about/contribute/code-blocks/>Add Code Blocks</a></li><li role=none><a role=treeitem title="Explains the shortcodes available and how to use them." href=/v1.8/about/contribute/shortcodes/>Use Shortcodes</a></li><li role=none><a role=treeitem title="Explains the standard markup used to format Istio documentation." href=/v1.8/about/contribute/formatting/>Follow Formatting Standards</a></li><li role=none><a role=treeitem title="Explains the style conventions used in the Istio documentation." href=/v1.8/about/contribute/style-guide/>Style Guide</a></li><li role=none><a role=treeitem title="Explains the terminology standards used in the Istio documentation." href=/v1.8/about/contribute/terminology/>Terminology Standards</a></li><li role=none><a role=treeitem title="Provides assets and instructions to create diagrams for the Istio documentation." href=/v1.8/about/contribute/diagrams/>Diagram Creation Guidelines</a></li></ul></li><li role=none><a role=treeitem title="List of recent changes to this website." href=/v1.8/about/log/>Website Content Changes</a></li></ul></div></div></div></nav></div><div class=article-container><button tabindex=-1 id=sidebar-toggler title="Toggle the navigation bar"><svg class="icon pull"><use xlink:href="/v1.8/img/icons.svg#pull"/></svg></button><nav aria-label=Breadcrumb><ol><li><a href=/v1.8/ title="Connect, secure, control, and observe services.">Istio</a></li><li><a href=/v1.8/about/ title="Get a bit more in-depth info about the Istio project.">About</a></li><li><a href=/v1.8/about/contribute/ title="Details how to create and maintain Istio documentation pages.">Contribute Documentation</a></li><li>Work with GitHub</li></ol></nav><article aria-labelledby=title><div class=title-area><div style=width:100%><h1 id=title>Work with GitHub</h1><p class=byline><span title="643 words"><svg class="icon clock"><use xlink:href="/v1.8/img/icons.svg#clock"/></svg><span>&nbsp;</span>4 minute read</span>
<span>&nbsp;</span>
<span></span></p></div></div><nav class=toc-inlined aria-label="Table of Contents"><div><hr><ol><li role=none aria-label="Before you begin"><a href=#before-you-begin>Before you begin</a><li role=none aria-label="Perform quick edits"><a href=#quick-edit>Perform quick edits</a><li role=none aria-label="Branching strategy"><a href=#branching-strategy>Branching strategy</a><li role=none aria-label="Istio community roles"><a href=#istio-community-roles>Istio community roles</a><li role=none aria-label="See also"><a href=#see-also>See also</a></li></ol><hr></div></nav><p>The Istio documentation follows the standard <a href=https://guides.github.com/introduction/flow/>GitHub collaboration flow</a>
for Pull Requests (PRs). This well-established collaboration model helps open
source projects manage the following types of contributions:</p><ul><li><a href=/v1.8/about/contribute/add-content>Add</a> new files to the repository.</li><li><a href=#quick-edit>Edit</a> existing files.</li><li><a href=/v1.8/about/contribute/review>Review</a> the added or modified files.</li><li>Manage multiple release or development <a href=#branching-strategy>branches</a>.</li></ul><p>The contribution guides assume you can complete the following tasks:</p><ul><li>Fork the <a href=https://github.com/istio/istio.io>Istio documentation repository</a>.</li><li>Create a branch for your changes.</li><li>Add commits to that branch.</li><li>Open a PR to share your contribution.</li></ul><h2 id=before-you-begin>Before you begin</h2><p>To contribute to the Istio documentation, you need to:</p><ol><li><p>Create a <a href=https://github.com>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><li><p>Install <a href=https://www.docker.com/get-started>Docker</a> on your authoring system
to preview and test your changes.</p></li></ol><p>The Istio documentation is published under the
<a href=https://github.com/istio/community/blob/master/LICENSE>Apache 2.0</a> license.</p><h2 id=quick-edit>Perform quick edits</h2><p>Anyone with a GitHub account who signs the CLA can contribute a quick
edit to any page on the Istio website. The process is very simple:</p><ol><li>Visit the page you wish to edit.</li><li>Add <code>preliminary</code> to the beginning of the URL. For example, to edit
<code>https://istio.io/about</code>, the new URL should be
<code>https://preliminary.istio.io/about</code></li><li>Click the pencil icon in the lower right corner.</li><li>Perform your edits on the GitHub UI.</li><li>Submit a Pull Request with your changes.</li></ol><p>Please see our guides on how to <a href=/v1.8/about/contribute/add-content>contribute new content</a>
or <a href=/v1.8/about/contribute/review>review content</a> to learn more about submitting more
substantial changes.</p><h2 id=branching-strategy>Branching strategy</h2><p>Active content development takes place using the master branch of the
<code>istio/istio.io</code> repository. On the day of an Istio release, we create a release
branch of master for that release. The following button takes you to the
repository on GitHub:</p><p><a class=btn href=https://github.com/istio/istio.io/>Browse this site&rsquo;s source
code</a></p><p>The Istio documentation repository uses multiple branches to publish
documentation for all Istio releases. Each Istio release has a corresponding
documentation branch. For example, there are branches called <code>release-1.0</code>,
<code>release-1.1</code>, <code>release-1.2</code> and so forth. These branches were created on the
day of the corresponding release. To view the documentation for a specific
release, see the <a href=https://archive.istio.io/>archive page</a>.</p><p>This branching strategy allows us to provide the following Istio online resources:</p><ul><li><p>The <a href=/v1.8/docs/>public site</a> shows the content from the current
release branch.</p></li><li><p>The preliminary site at <code>https://preliminary.istio.io</code> shows the content from
the master branch.</p></li><li><p>The <a href=https://archive.istio.io>archive site</a> shows the content from all prior
release branches.</p></li></ul><p>Given how branching works, if you submit a change into the master branch,
that change won&rsquo;t appear on <code>istio.io</code> until the next major Istio release
happens. If your documentation change is relevant to the current Istio release,
then it&rsquo;s probably worth also applying your change to the current release branch.
You can do this easily and automatically by using the special cherry-pick labels
on your documentation PR. For example, if you introduce a correction in a PR to
the master branch, you can apply the <code>cherrypick/release-1.4</code> label in order to
merge this change to the <code>release-1.4</code> branch.</p><p>When your initial PR is merged, automation creates a new PR in the release
branch which includes your changes. You may need to add a comment to the PR
that reads <code>@googlebot I consent</code> in order to satisfy the <code>CLA</code> bot that we
use.</p><p>On rare occasions, automatic cherry picks don&rsquo;t work. When that happens, the
automation leaves a note in the original PR indicating it failed. When
that happens, you must manually create the cherry pick and deal
with the merge issues that prevented the process from working automatically.</p><p>Note that we only ever cherry pick changes into the current release branch,
and never to older branches. Older branches are considered to be archived and
generally no longer receive any changes.</p><h2 id=istio-community-roles>Istio community roles</h2><p>Depending on your contributions and responsibilities, there are several roles
you can assume.</p><p>Visit our <a href=https://github.com/istio/community/blob/master/ROLES.md#role-summary>role summary page</a>
to learn about the roles, the related requirements and responsibilities, and
the privileges associated with the roles.</p><p>Visit our <a href=https://github.com/istio/community>community page</a> to learn more
about the Istio community in general.</p><nav id=see-also><h2>See also</h2><div class=see-also><div class=entry><p class=link><a data-skipendnotes=true href=/v1.8/about/contribute/review/>Documentation Review Process</a></p><p class=desc>Shows you how changes to the Istio documentation and website are reviewed and approved.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.8/blog/2020/steering-election-results/>2020 Steering Committee Election Results</a></p><p class=desc>Announcing the four newest Istio Steering Committee members.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.8/blog/2020/steering-changes/>Introducing the new Istio steering committee</a></p><p class=desc>The Istio Steering Committee is now in part proportionally allocated to companies based on contribution, and in part elected by community members.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.8/news/security/incorrect-sidecar-image-1.2.4/>Istio 1.2.4 sidecar image vulnerability</a></p><p class=desc>An erroneous 1.2.4 sidecar image was available due to a faulty release operation.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.8/blog/2019/sail-the-blog/>Sail the Blog!</a></p><p class=desc>Announces the new Istio blog policy.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.8/about/contribute/code-blocks/>Add Code Blocks</a></p><p class=desc>Explains how to include code in your documentation.</p></div></div></nav></article><nav class=pagenav><div class=left></div><div class=right><a title="Details how to contribute new documentation to Istio." href=/v1.8/about/contribute/add-content/>Add New Documentation<svg class="icon right-arrow"><use xlink:href="/v1.8/img/icons.svg#right-arrow"/></svg></a></div></nav><div id=feedback><div id=feedback-initial>Was this information useful?<br><button class="btn feedback" onclick="sendFeedback('en',1)">Yes</button>
<button class="btn feedback" onclick="sendFeedback('en',0)">No</button></div><div id=feedback-comment>Do you have any suggestions for improvement?<br><br><input id=feedback-textbox type=text placeholder="Help us improve..." data-lang=en></div><div id=feedback-thankyou>Thanks for your feedback!</div></div><div id=endnotes-container aria-hidden=true><h2>Links</h2><ol id=endnotes></ol></div></div><div class=toc-container><nav class=toc aria-label="Table of Contents"><div id=toc><ol><li role=none aria-label="Before you begin"><a href=#before-you-begin>Before you begin</a><li role=none aria-label="Perform quick edits"><a href=#quick-edit>Perform quick edits</a><li role=none aria-label="Branching strategy"><a href=#branching-strategy>Branching strategy</a><li role=none aria-label="Istio community roles"><a href=#istio-community-roles>Istio community roles</a><li role=none aria-label="See also"><a href=#see-also>See also</a></li></ol></div></nav></div></main><footer><div class=user-links><a class=channel title="Go download Istio 1.8.3 now" href=/v1.8/docs/setup/getting-started/#download aria-label="Download Istio"><span>download</span><svg class="icon download"><use xlink:href="/v1.8/img/icons.svg#download"/></svg>
</a><a class=channel title="Join the Istio discussion board to participate in discussions and get help troubleshooting problems" href=https://discuss.istio.io aria-label="Istio discussion board"><span>discuss</span><svg class="icon discourse"><use xlink:href="/v1.8/img/icons.svg#discourse"/></svg></a>
<a class=channel title="Stack Overflow is where you can ask questions and find curated answers on deploying, configuring, and using Istio" href=https://stackoverflow.com/questions/tagged/istio aria-label="Stack Overflow"><span>stack overflow</span><svg class="icon stackoverflow"><use xlink:href="/v1.8/img/icons.svg#stackoverflow"/></svg></a>
<a class=channel title="Interactively discuss issues with the Istio community on Slack" href=https://slack.istio.io aria-label=slack><span>slack</span><svg class="icon slack"><use xlink:href="/v1.8/img/icons.svg#slack"/></svg></a>
<a class=channel title="Follow us on Twitter to get the latest news" href=https://twitter.com/IstioMesh aria-label=Twitter><span>twitter</span><svg class="icon twitter"><use xlink:href="/v1.8/img/icons.svg#twitter"/></svg></a><div class=tag>for everyone</div></div><div class=info><p class=copyright>Istio Archive
1.8.3<br>&copy; 2020 Istio Authors, <a href=https://policies.google.com/privacy>Privacy Policy</a><br>Archived on February 9, 2021</p></div><div class=dev-links><a class=channel title="GitHub is where development takes place on Istio code" href=https://github.com/istio/community aria-label=GitHub><span>github</span><svg class="icon github"><use xlink:href="/v1.8/img/icons.svg#github"/></svg></a>
<a class=channel title="Access our team drive if you'd like to take a look at the Istio technical design documents" href=https://groups.google.com/forum/#!forum/istio-team-drive-access aria-label="team drive"><span>drive</span><svg class="icon drive"><use xlink:href="/v1.8/img/icons.svg#drive"/></svg></a>
<a class=channel title="If you'd like to contribute to the Istio project, consider participating in our working groups" href=https://github.com/istio/community/blob/master/WORKING-GROUPS.md aria-label="working groups"><span>working groups</span><svg class="icon working-groups"><use xlink:href="/v1.8/img/icons.svg#working-groups"/></svg></a><div class=tag>for developers</div></div></footer><div id=scroll-to-top-container aria-hidden=true><button id=scroll-to-top title="Back to top"><svg class="icon top"><use xlink:href="/v1.8/img/icons.svg#top"/></svg></button></div></body></html>