-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ec10388
commit f9a8fec
Showing
3 changed files
with
225 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -50,6 +50,9 @@ | |
| <li> | ||
| <a class="nav-link active" href="/community/">Community</a> | ||
| </li> | ||
| <li> | ||
| <a class="nav-link " href="/contributing/">Contributing</a> | ||
| </li> | ||
| <li><a class="nav-link btn-get-started" href="https://docs.kuadrant.io"><i class="bx bx-book"></i> Documentation</a></li> | ||
| <li><a class="nav-link btn-get-started" href="https://github.com/Kuadrant/"><i class="bx bxl-github"></i> GitHub</a></li> | ||
| </ul> | ||
|
|
@@ -63,25 +66,25 @@ | |
|
|
||
|
|
||
| <div class="container"> | ||
| <h1>Kuadrant Community</h1> | ||
| <h1 id="kuadrant-community" tabindex="-1"><a class="header-anchor" href="#kuadrant-community">Kuadrant Community</a></h1> | ||
| <p>Welcome to the Kuadrant community, where we're working to bring together Gateway API and Open Cluster Management to help you manage, scale, load-balance and secure your Ingress Gateways as a key part of your application connectivity, in a single cluster or the multi-cluster Kubernetes environments.</p> | ||
| <h3>Events and Meetings Calendar</h3> | ||
| <h3 id="events-and-meetings-calendar" tabindex="-1"><a class="header-anchor" href="#events-and-meetings-calendar">Events and Meetings Calendar</a></h3> | ||
| <p>We hold community meetings periodically, the details of which can be viewed below:</p> | ||
| <iframe src="https://calendar.google.com/calendar/embed?src=kuadrantdev%40gmail.com&ctz=Europe%2FDublin" style="border: 0" width="800" height="600" frameborder="0" scrolling="no"></iframe> | ||
| <h3>Source Code</h3> | ||
| <h3 id="source-code" tabindex="-1"><a class="header-anchor" href="#source-code">Source Code</a></h3> | ||
| <p>Kuadrant is an Open Source project, licensed under <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</a>. Source can be found on the <a href="https://github.com/Kuadrant">Kuadrant GitHub organisation</a>.</p> | ||
| <h3>Mailing List</h3> | ||
| <h3 id="mailing-list" tabindex="-1"><a class="header-anchor" href="#mailing-list">Mailing List</a></h3> | ||
| <p>We use a mailing list hosted by Google Groups to communicate as a community, answer questions, exchange ideas and make announcements about the project. Once subscribed, you can email the mailing list by sending an email to <a href="mailto:[email protected]">[email protected]</a>.</p> | ||
| <p>To subscribe, send an email to <a href="mailto:[email protected]">[email protected]</a><br> | ||
| To unsubscribe, send an email to <a href="mailto:[email protected]">[email protected]</a></p> | ||
| <h3>Issue Tracking & Bugs</h3> | ||
| <h3 id="issue-tracking-bugs" tabindex="-1"><a class="header-anchor" href="#issue-tracking-bugs">Issue Tracking & Bugs</a></h3> | ||
| <p>We use GitHub to track project bugs, enhancement requests and to do feature planning.</p> | ||
| <p>The <a href="https://github.com/Kuadrant/">Kuadrant project</a> is made up of a range of components, each with their own issue trackers. You can find all of these by navigating to a specific component, and looking at its respective <code>Issues</code>.</p> | ||
| <h3>Getting Involved</h3> | ||
| <h3 id="getting-involved" tabindex="-1"><a class="header-anchor" href="#getting-involved">Getting Involved</a></h3> | ||
| <p>We welcome new contributors to the project, be you a seasoned multi-cluster networking expert, or someone new who is looking to improve some wonky documentation you come across. Many of our respositories include variants of a <code>good-first-issue</code> label for issues that might be good to start with.</p> | ||
| <h4>Thinking about some initial contributions?</h4> | ||
| <h4 id="thinking-about-some-initial-contributions" tabindex="-1"><a class="header-anchor" href="#thinking-about-some-initial-contributions">Thinking about some initial contributions?</a></h4> | ||
| <p>Consider fixing some bugs, trying Kuadrant and telling us about your experience or helping us hone our documentation.</p> | ||
| <h3>Social Media</h3> | ||
| <h3 id="social-media" tabindex="-1"><a class="header-anchor" href="#social-media">Social Media</a></h3> | ||
| <p>You can find us on:</p> | ||
| <ul> | ||
| <li><a href="https://kubernetes.slack.com/archives/C05J0D0V525">Slack</a></li> | ||
|
|
@@ -90,7 +93,7 @@ <h3>Social Media</h3> | |
| <li><a href="https://stackoverflow.com/questions/tagged/kuadrant+authorino+limitador">Stack Overflow</a></li> | ||
| <li><a href="https://twitter.com/kuadrantio">Twitter</a></li> | ||
| </ul> | ||
| <h3>Security Disclosures</h3> | ||
| <h3 id="security-disclosures" tabindex="-1"><a class="header-anchor" href="#security-disclosures">Security Disclosures</a></h3> | ||
| <p>If you wish to make a responsible security disclosure, please email <a href="mailto:[email protected]">[email protected]</a>.</p> | ||
| <p>See also <a href="/.well-known/security.txt">security.txt</a>.</p> | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
|
|
||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
|
|
||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta content="width=device-width, initial-scale=1.0" name="viewport"> | ||
|
|
||
| <title>Contributing Guide</title> | ||
| <meta content="" name="description"> | ||
| <meta content="" name="keywords"> | ||
|
|
||
| <!-- Favicons --> | ||
| <link href="/static/img/favicon.png" rel="icon"> | ||
| <link href="/static/img/apple-touch-icon.png" rel="apple-touch-icon"> | ||
|
|
||
| <!-- Google Fonts --> | ||
| <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i,700,700i|Jost:300,300i,400,400i,500,500i,600,600i,700,700i|Poppins:300,300i,400,400i,500,500i,600,600i,700,700i" rel="stylesheet"> | ||
|
|
||
| <!-- Vendor CSS Files --> | ||
| <link href="/static/vendor/aos/aos.css" rel="stylesheet"> | ||
| <link href="/static/vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet"> | ||
| <link href="/static/vendor/bootstrap-icons/bootstrap-icons.css" rel="stylesheet"> | ||
| <link href="/static/vendor/boxicons/css/boxicons.min.css" rel="stylesheet"> | ||
| <link href="/static/vendor/glightbox/css/glightbox.min.css" rel="stylesheet"> | ||
| <link href="/static/vendor/remixicon/remixicon.css" rel="stylesheet"> | ||
| <link href="/static/vendor/swiper/swiper-bundle.min.css" rel="stylesheet"> | ||
|
|
||
| <!-- Template Main CSS File --> | ||
| <link href="/static/css/style.css" rel="stylesheet"> | ||
| </head> | ||
|
|
||
| <body> | ||
|
|
||
| <!-- ======= Header ======= --> | ||
| <header id="header" class="fixed-top "> | ||
| <div class="container d-flex align-items-center"> | ||
|
|
||
| <!-- <h1 class="logo me-auto"><a href="index.html">Kuadrant</a></h1> --> | ||
| <!-- Uncomment below if you prefer to use an image logo --> | ||
| <a href="/" class="logo me-auto"><img src="/static/img/kuadrant_logo_horizontal_reverse_rgb_600px.png" alt="" class="img-fluid"></a> | ||
|
|
||
| <nav id="navbar" class="navbar"> | ||
| <ul> | ||
| <li><a class="nav-link scrollto" href="/#hero">Home</a></li> | ||
| <li><a class="nav-link scrollto" href="/#features">Features</a></li> | ||
| <li><a class="nav-link scrollto" href="/#components">Components</a></li> | ||
| <li><a class="nav-link scrollto" href="/#faq">FAQs</a></li> | ||
|
|
||
| <li> | ||
| <a class="nav-link " href="/community/">Community</a> | ||
| </li> | ||
| <li> | ||
| <a class="nav-link active" href="/contributing/">Contributing</a> | ||
| </li> | ||
| <li><a class="nav-link btn-get-started" href="https://docs.kuadrant.io"><i class="bx bx-book"></i> Documentation</a></li> | ||
| <li><a class="nav-link btn-get-started" href="https://github.com/Kuadrant/"><i class="bx bxl-github"></i> GitHub</a></li> | ||
| </ul> | ||
| <i class="bi bi-list mobile-nav-toggle"></i> | ||
| </nav><!-- .navbar --> | ||
|
|
||
| </div> | ||
| </header><!-- End Header --> | ||
|
|
||
| <main id="main" class="other-page"> | ||
|
|
||
|
|
||
| <div class="container"> | ||
| <h1 id="contributors-guide" tabindex="-1"><a class="header-anchor" href="#contributors-guide">Contributors Guide</a></h1> | ||
| <!--- variables for repeated links ---> | ||
| <p>Welcome to the Kuadrant contributors guide! We are delighted that you are interested in getting involved in our project 🎉</p> | ||
| <p>As you get started, you are in the best position to give us feedback on areas of our project that we need help with such as:</p> | ||
| <ul> | ||
| <li>Gaps or inaccuracies in our <a href="https://docs.kuadrant.io/getting-started/">getting started</a> guide or <a href="https://docs.kuadrant.io/">documentation</a></li> | ||
| <li>Problems found while setting up your local development environment</li> | ||
| </ul> | ||
| <p>If anything doesn't make sense, or doesn't work when you run it, please feel free to either open a Github issue against the relevant component repository or reach out to us directly on <a href="https://kubernetes.slack.com/archives/C05J0D0V525">Slack</a> or via the Kuadrant <a href="mailto:[email protected]">mailing list</a>.</p> | ||
| <h2 id="ways-to-contribute" tabindex="-1"><a class="header-anchor" href="#ways-to-contribute">Ways to Contribute</a></h2> | ||
| <p>We welcome many different types of contributions covering areas such as:</p> | ||
| <ul> | ||
| <li>New features</li> | ||
| <li>Bug fixes</li> | ||
| <li>Documentation updates</li> | ||
| <li>Release management</li> | ||
| <li>Discussions, feedback and/or guidance on <a href="https://kubernetes.slack.com/archives/C05J0D0V525">Slack</a>/<a href="mailto:[email protected]">Mailing List</a></li> | ||
| </ul> | ||
| <h3 id="community-calls" tabindex="-1"><a class="header-anchor" href="#community-calls">Community Calls</a></h3> | ||
| <p>Each week we host a Kuadrant Community call which provides an open forum to discuss all things Kuadrant. Anyone is welcome to come along to this meeting to propose a topic, join in on discussions or just listen in to gain some context into what's going on in the project. For further details on how to join the call, see the Events and Meetings section on the website community <a href="https://kuadrant.io/community/#events-and-meetings-calendar">page</a>.</p> | ||
| <p>Missed a meeting? Don't worry! All of our Community calls are recorded and available from our <a href="https://www.youtube.com/playlist?list=PL2UsztbUdPcffkAukDbPJBLppSG6JUa2Q">YouTube channel</a>.</p> | ||
| <h2 id="ask-for-help" tabindex="-1"><a class="header-anchor" href="#ask-for-help">Ask for Help</a></h2> | ||
| <p>The best way to reach us with a question when contributing is to ask on:</p> | ||
| <ul> | ||
| <li>Our <a href="https://kubernetes.slack.com/archives/C05J0D0V525">Public Slack channel</a></li> | ||
| <li>The Kuadrant <a href="mailto:[email protected]">mailing list</a></li> | ||
| </ul> | ||
| <h2 id="reporting-issues" tabindex="-1"><a class="header-anchor" href="#reporting-issues">Reporting Issues</a></h2> | ||
| <p>To report an issue in the Kuadrant project, you can create a Github issue in the relevant component repository e.g. <a href="https://github.com/Kuadrant/limitador">Limitador</a>, <a href="https://github.com/Kuadrant/kuadrant-operator">Kuadrant Operator</a>, <a href="https://github.com/Kuadrant/authorino">Authorino</a> etc. If you are unsure of which component to log against, reach out via <a href="SlackChannelURL">Slack</a> or <a href="MailingList">email</a>. The more information you can provide the easier it will be to help resolve the issue, so please don't be shy on details.</p> | ||
| <h2 id="find-an-issue" tabindex="-1"><a class="header-anchor" href="#find-an-issue">Find an Issue</a></h2> | ||
| <p>A list of good first issues can be found from the Kuadrant Github <a href="https://github.com/orgs/Kuadrant/projects/18/views/7">projects board</a>. These issues are categorised per component. If you see an issue you're interested in progressing mark yourself as an assignee and update the issue status to <code>In Progress</code></p> | ||
| <p>On the rare occasion that there are no good first issues available, that’s OK! There is likely still something for you to work on. If you want to contribute but you don’t know where to start or can't find a suitable issue, you can reach out via the <a href="https://kubernetes.slack.com/archives/C05J0D0V525">Public Slack channel</a> for suggestions and/or guidance.</p> | ||
| <!--- WIP | ||
| ## Pull Request Lifecycle | ||
| [Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#pull-request-lifecycle) | ||
| ⚠️ **Explain your pull request process** | ||
| ## Sign Your Commits | ||
| [Instructions](https://contribute.cncf.io/maintainers/github/templates/required/contributing/#sign-your-commits) | ||
| ⚠️ **Keep either the DCO or CLA section depending on which you use** | ||
| ### DCO | ||
| Licensing is important to open source projects. It provides some assurances that | ||
| the software will continue to be available based under the terms that the | ||
| author(s) desired. We require that contributors sign off on commits submitted to | ||
| our project's repositories. The [Developer Certificate of Origin | ||
| (DCO)](https://probot.github.io/apps/dco/) is a way to certify that you wrote and | ||
| have the right to contribute the code you are submitting to the project. | ||
| You sign-off by adding the following to your commit messages. Your sign-off must | ||
| match the git user and email associated with the commit. | ||
| This is my commit message | ||
| Signed-off-by: Your Name <[email protected]> | ||
| Git has a `-s` command line option to do this automatically: | ||
| git commit -s -m 'This is my commit message' | ||
| If you forgot to do this and have not yet pushed your changes to the remote | ||
| repository, you can amend your commit with the sign-off by running | ||
| git commit --amend -s | ||
| ---> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| </main><!-- End #main --> | ||
|
|
||
| <!-- ======= Footer ======= --> | ||
| <footer id="footer"> | ||
|
|
||
| <div class="footer-top"> | ||
| <div class="container"> | ||
| <div class="row"> | ||
|
|
||
| <div class="col-lg-3 col-md-6 footer-contact"> | ||
| <h3>Kuadrant</h3> | ||
| <p> | ||
| Sponsored by: <a href="https://www.redhat.com"><img src="/static/img/clients/redhat.png" class="img-fluid img-125" alt=""></a | ||
| </p> | ||
| </div> | ||
|
|
||
| <div class="col-lg-3 col-md-6 footer-links"> | ||
| <h4>Useful Links</h4> | ||
| <ul> | ||
| <li><i class="bx bx-chevron-right"></i> <a href="#hero">Home</a></li> | ||
| <li><i class="bx bx-chevron-right"></i> <a href="#features">Features</a></li> | ||
| <li><i class="bx bx-chevron-right"></i> <a href="#components">Components</a></li> | ||
| <li><i class="bx bx-chevron-right"></i> <a href="#faq">FAQs</a></li> | ||
| </ul> | ||
| </div> | ||
|
|
||
| <div class="col-lg-3 col-md-6 footer-links"> | ||
| <h4>Our Social Networks</h4> | ||
| <div class="social-links mt-3"> | ||
| <a href="https://groups.google.com/g/kuadrant" class="envelope"><i class="bx bx-envelope"></i></a> | ||
| <a href="https://github.com/Kuadrant/" class="github"><i class="bx bxl-github"></i></a> | ||
| <a href="https://twitter.com/kuadrantio" class="twitter"><i class="bx bxl-twitter"></i></a> | ||
| <a href="https://www.youtube.com/channel/UCCZ0ByQA06jn9aB7YFL1Z6w" class="youtube"><i class="bx bxl-youtube"></i></a> | ||
| <a href="https://stackoverflow.com/questions/tagged/kuadrant+authorino+limitador" class="stack-overflow"><i class="bx bxl-stack-overflow"></i></a> | ||
| <a href="https://kubernetes.slack.com/archives/C05J0D0V525" class="slack"><i class="bx bxl-slack"></i></a> | ||
| </div> | ||
| </div> | ||
|
|
||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="container footer-bottom clearfix"> | ||
| <div class="copyright"> | ||
| © Copyright 2023 <strong><span>Kuadrant contributors</span></strong>. All Rights Reserved. | ||
| </div> | ||
|
|
||
| </div> | ||
| </footer><!-- End Footer --> | ||
|
|
||
| <div id="preloader"></div> | ||
| <a href="#" class="back-to-top d-flex align-items-center justify-content-center"><i class="bi bi-arrow-up-short"></i></a> | ||
|
|
||
| <!-- Vendor JS Files --> | ||
| <script src="/static/vendor/aos/aos.js"></script> | ||
| <script src="/static/vendor/bootstrap/js/bootstrap.bundle.min.js"></script> | ||
| <script src="/static/vendor/glightbox/js/glightbox.min.js"></script> | ||
| <script src="/static/vendor/isotope-layout/isotope.pkgd.min.js"></script> | ||
| <script src="/static/vendor/swiper/swiper-bundle.min.js"></script> | ||
| <script src="/static/vendor/waypoints/noframework.waypoints.js"></script> | ||
| <script src="/static/vendor/php-email-form/validate.js"></script> | ||
|
|
||
| <!-- Template Main JS File --> | ||
| <script src="/static/js/main.js"></script> | ||
|
|
||
| </body> | ||
|
|
||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters