Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a page on how to join the community #53

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ <h2 id="requirements">Requirements</h2>
<li>You've read the Cypht <a href="documentation.html">documentation</a> and the <a
href="https://github.com/cypht-org/cypht#readme">README</a>.
</li>
<li>You know about the <a href="https://gitter.im/cypht-org/community">Cypht community.</a> Please use this as help.
<li>You know about the <a href="https://gitter.im/cypht-org/community">Cypht community.</a> Please use this as help and check <a href="how-to-join.html">how to join the community.</a>
</li>
</ol>
<h2 id="git-guidelines">Git Guidelines</h2>
Expand Down
136 changes: 136 additions & 0 deletions how-to-join.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
<!DOCTYPE html>
<html class="no-js">

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>How to join</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/png" href="img/icon.ico">
<link rel="stylesheet" href="site.css">
</head>

<body>
<header>
<nav class="navbar navbar-expand-lg navbar-dark fixed-top">
<div class="container">
<a class="navbar-brand" href="index.html">
<img src="img/logo.svg" width="120" height="60" alt="">
</a>
<button class="navbar-toggler toggler-home" type="button" data-toggle="collapse"
data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false"
aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse " id="navbarSupportedContent">
<ul class="navbar-nav ml-lg-auto">
<li class="nav-item">
<a class="nav-link" href="index.html">Home <span class="sr-only">(current)</span>
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="features.html">Features</a>
</li>
<li class="nav-item">
<a class="nav-link" href="security.html">Security</a>
</li>
<li class="nav-item">
<a class="nav-link" href="modules.html">Mods</a>
</li>
<li class="nav-item">
<a class="nav-link" href="license.html">License</a>
</li>
<li class="nav-item">
<!--<a class="nav-link" href="tests.html">Test</a>-->
</li>
<li class="nav-item">
<a class="nav-link" href="documentation.html">Documentation</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://unencumberedbyfacts.com" target="_blank">Blog</a>
</li>
<li class="nav-item">
<a onclick="document.getElementsByClassName('navbar-collapse')[0].style.display='none';"
class="nav-link" href="contribute.html">Contribute</a>
</li>
</ul>
</div>
</div>
</nav>
</header>
<section class="contibute-section container">
<div class="container">
<h1>Getting Started with Cypht Community</h1>
<h2>Introduction</h2>
<p>
Welcome to the Cypht community! We are excited to have you join us and become a part of our mission to
develop and improve Cypht. This documentation is designed to help you get started with our community,
understand the development process, and contribute effectively to the project.
</p>
<h2>About the Cypht Community</h2>
<h3 class="h3">What is Cypht?</h3>
<p>
Cypht is an open-source email client and news aggregator with a modular design. Unlike traditional
applications, Cypht is built entirely from plugins, or "module sets," with the core modules being
essential. Users can customize their experience by adding or replacing modules to suit specific site
requirements. This modular approach offers flexibility and easy customization, although it may introduce
complexity.
</p>
<h3 class="h3">Our Values</h3>
<p>
As a community, we prioritize collaboration, inclusivity, and transparency. We encourage respect for
others and open communication. Our goal is to create a welcoming environment for all developers,
regardless of experience levels.
</p>
<h2>Joining the Community</h2>
<h3 class="h3">Getting Involved</h3>
<p>
To start your journey with the Cypht community,

Connect with us on <a href="https://gitter.im/cypht-org/community">gitter.</a>
</p>
<h2>Setting up Your Development Environment</h2>
<h3 class="h3">Tools and Software</h3>
<div>
<p>
Before you can contribute to Cypht, you need to set up your development environment. You will need
the
following tools and software:
</p>
<ul>
<li>A code editor of your choice (e.g., VSCode, Sublime Text)</li>
<li>Git for version control</li>
<li>PHP for developing Cypht</li>
<li>A web server (e.g., Apache, Nginx) for testing</li>
</ul>
</div>
<h3 class="h3">Configuration and Setup</h3>
<p>For installation, configuration, and setup, please check the <a href="install.html">installation
page</a></p>
<h3 class="h3">Contributing to Cypht</h3>
<p>When contributing to Cypht, follow these <a href="contribute.html">practices</a></p>
<h3 class="h3">Community Resources</h3>
<p>For more information and resources, explore the following:</p>
<ul>
<li><a href="documentation.html">Official Cypht Documentation</a></li>
<li><a href="features.html">Major features</a></li>
<li><a href="contribute.html">How to contribute</a></li>
</ul>

<p>
Don't hesitate to ask for help or guidance. We have experienced community members who are willing to mentor
and support newcomers. Feel free to reach out on <a href="https://gitter.im/cypht-org/community">Gitter.</a>
</p>
</div>
</section>
<script>
((window.gitter = {}).chat = {}).options = {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't work anymore

room: 'cypht-org/community'
};
</script>
<script src="jquery.slim.min.js"></script>
<script src="bootstrap.bundle.min.js"></script>
</body>

</html>
2 changes: 1 addition & 1 deletion install-2x.html
Original file line number Diff line number Diff line change
Expand Up @@ -377,4 +377,4 @@ <h4>Having problems?</h4>
<script src="bootstrap.bundle.min.js"></script>
</body>

</html>
</html>