janishutz/libreevent
1
0
Fork 0
mirror of https://github.com/janishutz/libreevent.git synced 2025-11-25 13:24:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Janis Hutz
2024-05-24 09:50:23 +02:00
parent 284f96a42d
commit 8e127a1cb5
44 changed files with 280 additions and 229 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
website/dist/docs/contributing/code-of-conduct/index.html vendored
View File

@@ -13,21 +13,23 @@
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Code of Conduct</h1>
<div class="doc-main">
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Code of Conduct</h1>
<p>If you would like to contribute code to libreevent, we'd like you to follow the following guidelines.</p>
<ul>
<li>Any code you want to contribute should have a reason to exist, please, if you find a bug or you have any idea for what you might want to contribute, ask around on GitHub, not that you do something nobody has use for or somebody else is already working on.</li>
<li>Always be polite to other developers. They spend their free-time working on this project. Even if the code is not as good as you might want it to be, don't start to offend people, give them some constructive criticism or suggestions on how they can improve it.</li>
<li>All the code that you produce should in no way be harmful to the consumer. If you have a proof-of-concept for a potential exploit, we'd like you to share it with us.</li>
<li>If you have code that is unfinished and you don't have the time or willingness to finish it, please open a PR as a draft and we'll mark it as up for grabs.</li>
<li>Please do some testing on the code you write to make sure it works as expected. We will also do our own testing, but we expect you to have checked that everything is working as it should beforehands.</li>
<li>If you have code that is unfinished, and you don't have the time or willingness to finish it, please open a PR as a draft, and we'll mark it as up for grabs.</li>
<li>Please do some testing on the code you write to make sure it works as expected. We will also do our own testing, but we expect you to have checked that everything is working as it should beforehand.</li>
<li>Please follow our programming style and make sure that eslint does not show any errors with the code you just wrote.</li>
</ul>
</div>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>

12
website/dist/docs/contributing/design-guidelines/index.html vendored
View File

@@ -13,14 +13,16 @@
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Design Guidelines</h1>
<div class="doc-main">
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Design Guidelines</h1>
<p>Everything in libreevent should be designed in a way that puts legibility and ease of use as its priority, instead of opting for special effects that are, undeniably, nice, but do not contribute to improved usability and, as every effect needs some lines of code, also wastes bandwidth that is very limited if a lot of people access the sites simultaneously.</p>
<p>All color used in libreevent should be a color variable that is defined in the App.vue files which means those colors can be changed easily in the future or as part of switching to dark mode. When designing something, please avoid adding more colors whenever possible.</p>
</div>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>

12
website/dist/docs/contributing/index.html vendored
View File

@@ -13,11 +13,12 @@
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Getting Started</h1>
<div class="doc-main">
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Getting Started</h1>
<p>You are interested in helping develop this project to make it even better? Then let us show you, how you may help and what you should keep in mind!</p>
<h2>Things to contribute to</h2>
<p>You may contribute to any of the following things (list is not exhaustive):</p>
@@ -45,6 +46,7 @@
<h2>Before starting to contribute</h2>
<p>Before you start coding, please make yourself familiar with the code of conduct and the linter settings. Another thing that is not required, but certainly a good idea is to open an issue on our GitHub to have a discussion about the changes you want to make so that you don't waste your time, if the thing you want to do is not something we feel like is necessary.</p>
</div>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>

12
website/dist/docs/contributing/packaging/index.html vendored
View File

@@ -13,11 +13,12 @@
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Packaging</h1>
<div class="doc-main">
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Packaging</h1>
<p>libreevent has a very simple packaging script built in, it's called package.sh and can be run on any bash-compatible shell. This is another thing that should be improved: Add a batch script for the same purpose, it makes Windows user's life so much easier!</p>
<p>You can just run the script in a terminal by typing</p>
<pre><code>./package.sh
@@ -30,6 +31,7 @@
</code></pre>
<p>in the <em>src/server</em>, <em>src/webapp/main</em> and <em>src/webapp/setup</em> directories. This creates the <em>node_modules</em> folder in each of those directories. This is also what you need to do, if you want to upload the development version of libreevent.</p>
</div>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>

16
website/dist/docs/contributing/plugins/index.html vendored
View File

@@ -13,22 +13,24 @@
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Contributing Plugins</h1>
<div class="doc-main">
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Contributing Plugins</h1>
<p>If you wish to contribute plugins and have them accepted into the official repository then your plugin has to:</p>
<ul>
<li>fulfill the code layout requirements given by the linter config</li>
<li>fulfil the code layout requirements given by the linter config</li>
<li>follow the libreevent <a href="/docs/contributing/design-guidelines">design guidelines</a></li>
<li>conform to our <a href="/docs/contributing/code-of-conduct">code of conduct</a></li>
<li>not contain any immediately obvious flaws (as layed out in the code of conduct), be it in terms of security or reliability</li>
<li>not contain any immediately obvious flaws (as laid out in the code of conduct), be it in terms of security or reliability</li>
<li>provide all necessary files for libreevent</li>
<li>offer settings if possible and necessary and a way to graphically edit them</li>
<li>have extensive documentation on its usage. Once accepted into the official repos, the documentation will be added to the official documentation.</li>
</ul>
</div>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>