mirror of
https://github.com/Ocelot-Social-Community/Ocelot-Social.git
synced 2025-12-13 07:46:06 +00:00
591 lines
19 KiB
HTML
591 lines
19 KiB
HTML
|
||
<!DOCTYPE HTML>
|
||
<html lang="" >
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
<title>Edit this Documentation · Ocelot.Social – Developer Documentation</title>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||
<meta name="description" content="">
|
||
<meta name="generator" content="GitBook 3.2.3">
|
||
<meta name="author" content="busFaktor() e.V.">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="gitbook/style.css">
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="gitbook/gitbook-plugin-hints/plugin-hints.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="gitbook/gitbook-plugin-tabs2/tabs.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="gitbook/gitbook-plugin-search-pro/search.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="gitbook/gitbook-plugin-splitter/splitter.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="gitbook/gitbook-plugin-chapter-fold/chapter-fold.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<meta name="HandheldFriendly" content="true"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
||
<meta name="apple-mobile-web-app-capable" content="yes">
|
||
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
||
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
|
||
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
|
||
|
||
|
||
<link rel="next" href="neo4j/" />
|
||
|
||
|
||
<link rel="prev" href="./" />
|
||
|
||
|
||
</head>
|
||
<body>
|
||
|
||
<div class="book">
|
||
<div class="book-summary">
|
||
|
||
|
||
<div id="book-search-input" role="search">
|
||
<input type="text" placeholder="Type to search" />
|
||
</div>
|
||
|
||
|
||
<nav role="navigation">
|
||
|
||
|
||
|
||
<ul class="summary">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="chapter " data-level="1.1" data-path="./">
|
||
|
||
<a href="./">
|
||
|
||
|
||
Introduction
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter active" data-level="1.2" data-path="edit-this-documentation.html">
|
||
|
||
<a href="edit-this-documentation.html">
|
||
|
||
|
||
Edit this Documentation
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.3" data-path="neo4j/">
|
||
|
||
<a href="neo4j/">
|
||
|
||
|
||
Neo4J
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.4" data-path="backend/">
|
||
|
||
<a href="backend/">
|
||
|
||
|
||
Backend
|
||
|
||
</a>
|
||
|
||
|
||
|
||
<ul class="articles">
|
||
|
||
|
||
<li class="chapter " data-level="1.4.1" data-path="backend/graphql.html">
|
||
|
||
<a href="backend/graphql.html">
|
||
|
||
|
||
GraphQL
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.4.2" data-path="backend/neo4j-graphql-js.html">
|
||
|
||
<a href="backend/neo4j-graphql-js.html">
|
||
|
||
|
||
neo4j-graphql-js
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.5" data-path="webapp/">
|
||
|
||
<a href="webapp/">
|
||
|
||
|
||
Webapp
|
||
|
||
</a>
|
||
|
||
|
||
|
||
<ul class="articles">
|
||
|
||
|
||
<li class="chapter " data-level="1.5.1" data-path="webapp/components.html">
|
||
|
||
<a href="webapp/components.html">
|
||
|
||
|
||
Components
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.5.2" data-path="webapp/html.html">
|
||
|
||
<a href="webapp/html.html">
|
||
|
||
|
||
HTML
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.5.3" data-path="webapp/scss.html">
|
||
|
||
<a href="webapp/scss.html">
|
||
|
||
|
||
SCSS
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.5.4" data-path="webapp/vue.html">
|
||
|
||
<a href="webapp/vue.html">
|
||
|
||
|
||
Vue
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.6" data-path="testing.html">
|
||
|
||
<a href="testing.html">
|
||
|
||
|
||
Testing Guide
|
||
|
||
</a>
|
||
|
||
|
||
|
||
<ul class="articles">
|
||
|
||
|
||
<li class="chapter " data-level="1.6.1" data-path="cypress/">
|
||
|
||
<a href="cypress/">
|
||
|
||
|
||
End-to-end tests
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.6.2" data-path="webapp/testing.html">
|
||
|
||
<a href="webapp/testing.html">
|
||
|
||
|
||
Frontend tests
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.6.3" data-path="backend/testing.html">
|
||
|
||
<a href="backend/testing.html">
|
||
|
||
|
||
Backend tests
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.7" data-path="DOCKER_MORE_CLOSELY.html">
|
||
|
||
<a href="DOCKER_MORE_CLOSELY.html">
|
||
|
||
|
||
Docker More Closely
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.8" >
|
||
|
||
<a target="_blank" href="https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding/blob/master/deployment/README.md">
|
||
|
||
|
||
Deployment
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.9" data-path="CONTRIBUTING.html">
|
||
|
||
<a href="CONTRIBUTING.html">
|
||
|
||
|
||
Contributing
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.10" data-path="cypress/features.html">
|
||
|
||
<a href="cypress/features.html">
|
||
|
||
|
||
Feature Specification
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.11" data-path="CODE_OF_CONDUCT.html">
|
||
|
||
<a href="CODE_OF_CONDUCT.html">
|
||
|
||
|
||
Code of conduct
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.12" data-path="LICENSE.html">
|
||
|
||
<a href="LICENSE.html">
|
||
|
||
|
||
License
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
|
||
|
||
</nav>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="book-body">
|
||
|
||
<div class="body-inner">
|
||
|
||
|
||
|
||
<div class="book-header" role="navigation">
|
||
|
||
|
||
<!-- Title -->
|
||
<h1>
|
||
<i class="fa fa-circle-o-notch fa-spin"></i>
|
||
<a href="." >Edit this Documentation</a>
|
||
</h1>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="page-wrapper" tabindex="-1" role="main">
|
||
<div class="page-inner">
|
||
|
||
<div id="book-search-results">
|
||
<div class="search-noresults">
|
||
|
||
<section class="normal markdown-section">
|
||
|
||
<h1 id="edit-this-documentation">Edit this Documentation</h1>
|
||
<p>Find the <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/SUMMARY.md" target="_blank"><strong>table of contents</strong> for this documentation on GitHub</a> and navigate to the file you need to update.</p>
|
||
<p>Click on the <strong>edit pencil</strong> on the right side directly above the text to edit this file on your fork of Human Connection (HC).</p>
|
||
<p>You can see a preview of your changes by clicking the <strong>Preview changes</strong> tab aside the <strong>Edit file</strong> tab.</p>
|
||
<p>If you are ready, fill in the <strong>Propose file change</strong> at the end of the webpage.</p>
|
||
<p>After that you have to send your change to the HC basis with a pull request. Here make a comment which issue you have fixed. (If you are working on one of our <a href="https://github.com/Ocelot-Social-Community/Ocelot-Social/issues" target="_blank">open issues</a> please include the number.)</p>
|
||
<h2 id="markdown-your-documentation">Markdown your documentation</h2>
|
||
<p>To design your documentation see the syntax description at GitBook:</p>
|
||
<p><a href="https://toolchain.gitbook.com/syntax/markdown.html" target="_blank">https://toolchain.gitbook.com/syntax/markdown.html</a></p>
|
||
<h3 id="some-quick-examples">Some quick Examples</h3>
|
||
<h4 id="headlines">Headlines</h4>
|
||
<pre><code class="lang-markdown"><span class="hljs-section"># Main headline</span>
|
||
<span class="hljs-section">## Smaller headlines</span>
|
||
<span class="hljs-section">### Small headlines</span>
|
||
</code></pre>
|
||
<h4 id="tabs">Tabs</h4>
|
||
<pre><code class="lang-markdown">{% tabs %}
|
||
{% tab title="XXX" %}
|
||
XXX
|
||
{% endtab %}
|
||
{% tab title="XXX" %}
|
||
XXX
|
||
{% endtab %}
|
||
…
|
||
{% endtabs %}
|
||
</code></pre>
|
||
<h4 id="commands">Commands</h4>
|
||
<pre><code class="lang-markdown"><span class="hljs-code">```</span><span class="xml"><span class="hljs-tag"><<span class="hljs-name">LANGUAGE</span>></span></span> (for text highlighting)
|
||
XXX
|
||
<span class="hljs-code">```</span>
|
||
</code></pre>
|
||
<h4 id="links">Links</h4>
|
||
<pre><code class="lang-markdown">[<span class="hljs-string">XXX</span>](<span class="hljs-link">https://XXX</span>)
|
||
</code></pre>
|
||
<h4 id="screenshots-or-other-images">Screenshots or other Images</h4>
|
||
<pre><code class="lang-markdown">![<span class="hljs-string">XXX</span>](<span class="hljs-link">https://XXX</span>)
|
||
</code></pre>
|
||
<h4 id="hints-for-todos">Hints For ToDos</h4>
|
||
<pre><code class="lang-markdown">{% hint style="info" %} TODO: XXX {% endhint %}
|
||
</code></pre>
|
||
<h2 id="host-the-screenshots">Host The Screenshots</h2>
|
||
<p>Often we need screenshots to explain things.</p>
|
||
<h3 id="host-on-ocelot-social-github-repository">Host On Ocelot-Social GitHub repository</h3>
|
||
<p><div class="alert alert-info hints-alert"><div class="hints-icon"><i class="fa fa-info-circle"></i></div><div class="hints-container"><p> TODO: How to host on Ocelot-Social GitHub repository ... </p>
|
||
</div></div></p>
|
||
<h3 id="quick-solution">Quick Solution</h3>
|
||
<p>To quickly host the screenshots go to:</p>
|
||
<p><a href="https://imgur.com" target="_blank">https://imgur.com</a>.</p>
|
||
<p>There click the green button <strong>New post</strong>.</p>
|
||
<p>Drag the image into the appropriate area.</p>
|
||
<p>Right click on it and choose kind of <strong>Open link in new tab</strong>.</p>
|
||
<p>Copy the URL and paste it were you need it.</p>
|
||
<h2 id="screenshot-modification">Screenshot modification</h2>
|
||
<h3 id="add-an-arrow-or-some-other-marking-stuff">Add an arrow or some other marking stuff</h3>
|
||
<p><div class="markdown-tabs"><ul class="nav nav-tabs" role="tablist"><li role="presentation" class="active"><a href="#tab-413" aria-controls="tab-413" role="tab" data-toggle="tab">macOS</a></li><li role="presentation" class=""><a href="#tab-414" aria-controls="tab-414" role="tab" data-toggle="tab">Windows</a></li><li role="presentation" class=""><a href="#tab-415" aria-controls="tab-415" role="tab" data-toggle="tab">Linux</a></li></ul><div class="tab-content"><div role="tabpanel" class="tab-pane active" id="tab-413"><h4 id="in-the-preview-app">In the Preview App</h4><p>Got to: <strong>Menu</strong> + <strong>Tools</strong> (GER: Werkzeuge) + <strong>Annotate</strong> (GER: Anmerkungen) + etc.</p></div><div role="tabpanel" class="tab-pane " id="tab-414"></div><div role="tabpanel" class="tab-pane " id="tab-415"></div></div></div></p>
|
||
|
||
|
||
</section>
|
||
|
||
</div>
|
||
<div class="search-results">
|
||
<div class="has-results">
|
||
|
||
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
||
<ul class="search-results-list"></ul>
|
||
|
||
</div>
|
||
<div class="no-results">
|
||
|
||
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<a href="./" class="navigation navigation-prev " aria-label="Previous page: Introduction">
|
||
<i class="fa fa-angle-left"></i>
|
||
</a>
|
||
|
||
|
||
<a href="neo4j/" class="navigation navigation-next " aria-label="Next page: Neo4J">
|
||
<i class="fa fa-angle-right"></i>
|
||
</a>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<script>
|
||
var gitbook = gitbook || [];
|
||
gitbook.push(function() {
|
||
gitbook.page.hasChanged({"page":{"title":"Edit this Documentation","level":"1.2","depth":1,"next":{"title":"Neo4J","level":"1.3","depth":1,"path":"neo4j/README.md","ref":"neo4j/README.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["-lunr","-search","-sharing","hints","tabs2","theme-simple@git+https://github.com/plugins-zander/gitbook-plugin-theme-simple.git","search-pro@git+https://github.com/plugins-zander/gitbook-plugin-search-pro.git","splitter@git+https://github.com/plugins-zander/gitbook-plugin-splitter.git","edit-link@git+https://github.com/plugins-zander/gitbook-plugin-edit-link.git","gtag@git+https://github.com/plugins-zander/gitbook-plugin-gtag.git","chapter-fold@git+https://github.com/plugins-zander/gitbook-plugin-chapter-fold.git","copy-code-button@git+https://github.com/plugins-zander/gitbook-plugin-copy-code-button.git"],"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"},"pluginsConfig":{"chapter-fold":{},"splitter":{},"search-pro":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"sitemap-general":{"prefix":"https://zlogs.net/gitbook-action/"},"fontsettings":{"theme":"white","family":"sans","size":2},"gtag":{"token":""},"tabs2":{},"highlight":{},"theme-simple":{"showLevel":false,"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"}},"copy-code-button":{},"edit-link":{"label":"EDIT","base":"https://github.com/Ocelot-Social-Community/Ocelot-Social/edit/master/"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"busFaktor() e.V.","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Ocelot.Social – Developer Documentation","gitbook":"3.2.3","description":"Developer Documentation by Gitbook-Action"},"file":{"path":"edit-this-documentation.md","mtime":"2023-08-15T14:25:15.000Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2023-08-15T15:04:47.802Z"},"basePath":".","book":{"language":""}});
|
||
});
|
||
</script>
|
||
</div>
|
||
|
||
|
||
<script src="gitbook/gitbook.js"></script>
|
||
<script src="gitbook/theme.js"></script>
|
||
|
||
|
||
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
|
||
|
||
|
||
|
||
<script src="gitbook/gitbook-plugin-tabs2/tabs.js"></script>
|
||
|
||
|
||
|
||
<script src="gitbook/gitbook-plugin-search-pro/jquery.mark.min.js"></script>
|
||
|
||
|
||
|
||
<script src="gitbook/gitbook-plugin-search-pro/search.js"></script>
|
||
|
||
|
||
|
||
<script src="gitbook/gitbook-plugin-splitter/splitter.js"></script>
|
||
|
||
|
||
|
||
<script src="gitbook/gitbook-plugin-edit-link/plugin.js"></script>
|
||
|
||
|
||
|
||
<script src="gitbook/gitbook-plugin-gtag/plugin.js"></script>
|
||
|
||
|
||
|
||
<script src="gitbook/gitbook-plugin-chapter-fold/chapter-fold.js"></script>
|
||
|
||
|
||
|
||
<script src="gitbook/gitbook-plugin-copy-code-button/toggle.js"></script>
|
||
|
||
|
||
|
||
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
|
||
|
||
|
||
|
||
</body>
|
||
</html>
|
||
|