blob: beb3961f49d24eb306b5d20b475bb0ff82315632 [file] [log] [blame]
<!doctype html>
<html class="no-js" lang="en" dir="ltr">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Documentation - Apache Infrastructure Website</title>
<link rel="stylesheet" href="/css/foundation.css">
<link rel="stylesheet" href="/css/app.css">
<link rel="stylesheet" href="/css/font-awesome.min.css">
<style type="text/css">
.frontbox {
border-radius: 8%;
border: 1px solid #999; background: #444; color: #EEE; padding: 6px; margin: 3px;
}
.frontbox:hover {
border-top: 4px solid #1583CC;
margin-top: 0px;
cursor: pointer;
}
.clickable {
/* height was reduced by 40% */
height: 60%;
width: 30%;
position: absolute;
z-index: 1;
}
</style>
<link rel="stylesheet"
href="/highlight/default.min.css">
<script src="/highlight/highlight.min.js"></script> </head>
<body style="background: #C1C1C1;">
<!-- Menu bar --->
<div class="row">
<div class="top-bar" style="padding: 0; margin-bottom: 10px; background: #222; border: 1px solid #DDD; border-bottom-right-radius: 4px; border-bottom-left-radius: 4px;">
<div class="hide-for-small-only">
<div class="top-bar-left">
<ul class="menu" style="background: #222; padding: 0px; line-height: 1; border-bottom-left-radius: 4px;">
<li class="notable-logo"><a href="/" target="_self" style="padding: 3px; padding-left: 7px;">
<img style="vertical-align: middle;" src='/images/feather.png' width='18'/><span style="font-size: 1.30rem; color: #1583CC; text-transform: uppercase;">Apache Infrastructure</span></a>
</li>
</ul>
</div>
<div class="top-bar-right">
<ul class="dropdown menu horizontal" data-dropdown-menu style="background: #222; font-size: 0.8rem; text-transform: uppercase; padding-top: 5px;">
<li class="is-dropdown-submenu-parent">
<a href="#" target="_self" style="padding-left: 7px;">About</a>
<ul class="menu" style="background: #222; font-size: 0.7rem; text-transform: uppercase; padding-top: 5px; margin-top: 5px;">
<li><a href="/team.html">About the team</a></li>
<li><a href="https://blogs.apache.org/infra/" target="_blank">The Infra Blog</a></li>
</ul>
</li>
<li><a href="/policies.html" target="_blank" style="padding-left: 5px;">Policies</a></li>
<li class="is-dropdown-submenu-parent">
<a href="#" target="_self" style="padding-left: 0px;">Services-Tools</a>
<ul class="menu" style="background: #222; font-size: 0.7rem; text-transform: uppercase; padding-top: 5px; margin-top: 5px;">
<li><a href="/services.html">Services and Tools</a></li>
<li><a href="/machines.html" target="_blank" >Machines and Fingerprints</a></li>
<li><a href="https://blocky.apache.org" target="_blank" >Blocky</a></li>
<li><a href="https://app.datadoghq.com/account/login?next=%2Finfrastructure" target="_blank" >DataDog</a></li>
<li><a href="https://whimsy.apache.org/roster/committer/" target="_blank" >Committer Search</a></li>
</ul>
</li>
<li><a href="/doc.html" target="_blank" style="padding-left: 5px;">Documentation</a></li>
<li class="is-dropdown-submenu-parent">
<a href="#" target="_self" style="padding-left: 0px;">Contribute</a>
<ul class="menu" style="background: #222; font-size: 0.7rem; text-transform: uppercase; padding-top: 5px; margin-top: 5px;">
<li><a href="/infra-volunteer.html">Volunteer with Infra</a></li>
<li><a href="/how-to-mirror.html">Become an ASF download mirror</a></li>
<li><a href="/hosting-external-agent.html">Host a Jenkins or Buildbot agent</a></li>
</ul>
</li>
<li><a href="/stats.html" target="_blank" style="padding-left: 5px;">Status</a></li>
<li><a href="/contact.html" style="padding-left: 5px;"><i class="fa fa-comments" style="color: #FFF; font-size: 0.9rem;"></i>Contact us</a></li>
</ul>
</div>
</div>
</div>
</div>
<!-- bread crumb -->
<div class="row">
<div class="large-12 columns" style="font-size: 0.8rem; background-color: rgba(255,255,255,0.75); margin-bottom: 5px;">
<a href="/">Home</a>
<i class="fa fa-angle-double-right"></i>
<a href="/doc.html">
Documentation </a>
(<a href="https://github.com/apache/infrastructure-website/tree/master/content/pages/doc.md">edit</a>)
</div>
</div>
<!-- contents -->
<div class="row">
<div class="large-12 columns">
<div class="callout">
<h2>
Documentation
</h2>
<p>Infra provides a library of resources that is constantly evolving to reflect the current state of Apache's infrastructure and policies.</p>
<h3>Overview</h3>
<p>An extensive infrastructure overview for developers is <a href="https://www.apache.org/dev/" target="_blank">here</a>.</p>
<h3>General guides</h3>
<ul>
<li><a href="understanding-opensource.html">Understanding Opensource</a></li>
<li><a href="bug-writing-guide.html">Writing a good bug report</a></li>
<li><a href="jira-guidelines.html">Creating a Jira ticket</a></li>
<li><a href="patch.html">Creating a patch for project code</a></li>
</ul>
<h3>PMC resources</h3>
<h4>Source code</h4>
<ul>
<li><a href="version-control.html">Project source code repositories</a></li>
<li><a href="repository-faq.html">Repositories for Maven releases and snapshots</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features" target="_blank">.asf.yaml features for Git repositories</a></li>
<li><a href="github-actions-secrets.html">GitHub Actions and Secrets</a>
<ul>
<li><a href="github-actions-policy.html">GitHub Actions policy</a></li>
</ul>
</li>
</ul>
<h4>Build and release</h4>
<ul>
<li><a href="release-publishing.html">Release creation process</a></li>
<li>Creating optional <a href="publishing-maven-artifacts.html">Maven releases</a></li>
<li><a href="release-signing.html">Signing releases</a></li>
<li><a href="openpgp.html">Cryptography with OpenPGP</a></li>
<li><a href="release-distribution.html">Release distribution policy</a></li>
<li><a href="release-download-pages.html">Release download pages</a></li>
<li><a href="licensing-howto.html">Assembling LICENSE and NOTICE files</a></li>
<li>General information about <a href="mirrors.html">content distribution</a></li>
<li><a href="crypto.html">Handling cryptography within an ASF release</a></li>
<li><a href="self-hosted-runners.html">Deploying a self-hosted runner</a></li>
</ul>
<h4>Website, blog and wiki</h4>
<ul>
<li><a href="website-guidelines.html">Project website guidelines</a>. <strong>Note</strong>: No new projects can use the Apache CMS, which has reached end-of-life. Any projects still using the CMS must migrate to another resource to maintain their websites. Projects that have not migrated their site may find that they are no longer able to update it.</li>
<li>Here is how one project <a href="https://cwiki.apache.org/confluence/display/INFRA/How+Apache+Jena+migrated+from+the+CMS" target="_blank">did the migration</a>.</li>
<li>A <a href="asf-pelican.html">project site template</a> written in Pelican is available to smooth migration away from the CMS, and to support creation of new project sites.</li>
<li><a href="project-site.html">Managing your project website</a></li>
<li><a href="project-blog.html">Project blog</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/INFRA/Managing+permissions+on+your+project%27s+Confluence+Space" target="_blank">Managing permissions on your project's Confluence space</a>.</li>
</ul>
<h4>Other</h4>
<ul>
<li><a href="managing-committers.html">Managing project committers</a></li>
<li><a href="vm-policy.html">Virtual machine for your project</a></li>
<li><a href="mailing-list-moderation.html">Mailing list moderation</a></li>
</ul>
<h3>Committer resources</h3>
<ul>
<li><a href="new-committers-guide.html">New committer's guide</a></li>
<li><a href="committer-email.html">Managing your Apache email address</a></li>
<li><a href="https://people.apache.org" target="_blank">Apache People</a> provides a simple phone book-like
lookup for Apache Committers.</li>
<li><a href="https://whimsy.apache.org/" target="_blank">The Whimsy Project</a> provides a number of committer-specific tools for finding information about Apache people.</li>
<li><a href="key-transition.html">Transitioning to a new PGP key</a></li>
<li><a href="git-primer.html">Getting started with Git</a></li>
<li>Information on setting up and using <a href="https://cwiki.apache.org/confluence/display/INFRA/OPIE" target="_blank">OPIE (One Password In Everything)</a>.</li>
<li>The ASF has a fee-waiver arrangement so that committers participating in ASF projects can make free use of the <a href="apple-dev-program.html">Apple Developer Program</a> to prepare and distribute project applications for Apple operating systems.</li>
<li><a href="contrib-email-tips.html">Apache mailing list etiquette</a></li>
<li><a href="patch.html">How to submit a patch for project code</a></li>
</ul>
<h3>Contributor resources</h3>
<p><a href="contributors.html">New contributor's guide</a></p>
<h3>Infra Wiki</h3>
<p>The <a href="https://cwiki.apache.org/confluence/display/INFRA/Documentation+Index" target="_blank">Infra Wiki</a> provides scripts, how-to articles, and code samples. Most pages support the functions of the Infra team, but a great deal of material has guidance for project committers and PMCs.</p>
<p>You can also browse the complete <a href="https://cwiki.apache.org/" target="_blank">ASF Wiki</a>.</p>
</div>
</div>
</div>
<!-- footer -->
<div class="row">
<div class="large-12 medium-12 columns">
<p style="font-style: italic; font-size: 0.8rem; text-align: center;">
Copyright 2022, <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/>
Apache&reg; and the Apache feather logo are trademarks of The Apache Software Foundation...
</p>
</div>
</div>
<script src="/js/vendor/jquery.js"></script>
<script src="/js/vendor/what-input.js"></script>
<script src="/js/vendor/foundation.js"></script>
<script src="/js/app.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</body>
</html>