Commit c683e0db authored by Ali Rıza's avatar Ali Rıza

docs skeleton

parent d8df2691
==================
Coding Style Guide
==================
==================
Contribution Guide
==================
Since Beiran is a free software and follows the free software
development conventions and patterns, it is open for any kind
of contribution. You can:
- open an issue to discuss on a bug, a new feature, application
design or architecture, please see [Creating an Issue document]
- fork and create a merge request
- start a new plugin project
Creating a Plugin
-----------------
===================
Configuration Guide
===================
==================
Contribution Guide
==================
What can I do?
--------------
Since Beiran is a free software and follows the free software
development conventions and patterns, it is open for any kind
of contribution. You can:
of contribution.
- if you find a bug, please report by creating an issue
- if you need a new feature, an enhancement or any kind of
changes, please create an issue,
- if you have already fixed or implemented something, please
create a merge request,
- start a plugin project
- open an issue to discuss on a bug, a new feature, application
design or architecture, please see [Creating an Issue document]
- fork and create a merge request
- start a new plugin project
How to code
-----------
Before starting any kind of contribution, please check our contribution
guidelines.
- :doc:`Coding conventions <coding_style_guide>`
- :doc:`Git practices <git_practices>`
- :doc:`How to create an issue <issue>`
Creating a Plugin
-----------------
......@@ -23,3 +36,4 @@ Till now, we have 3 kinds of plugins and implementations are followings:
- discovery plugins (dns, zeroconf)
- interface plugins (k8s)
Please continue with :doc:`How to Create A plugin<how_to_create_a_plugin>`
=============
Git Practices
=============
......@@ -3,8 +3,9 @@ How to create a Beiran Plugin
=============================
Before starting, please check our contribution guidelines.
- Coding conventions <>
- Git practices <>
- :doc:`Coding conventions <coding_style_guide>`
- :doc:`Git practices <git_practices>`
- :doc:`How to create an issue <issue>`
Creating a Plugin
......@@ -80,5 +81,4 @@ purposes. For example docker plugin cli modlue `cli_docker.py` has method below:
"""Main subcommand method."""
pass
Other modules are arbitrary and depends on how your implementation is structured.
=====================================
Gitlab, Project Management and Issues
=====================================
==================
Contribution Guide
==================
Since Beiran is a free software and follows the free software
development conventions and patterns, it is open for any kind
of contribution. You can:
- open an issue to discuss on a bug, a new feature, application
design or architecture, please see [Creating an Issue document]
- fork and create a merge request
- start a new plugin project
Creating a Plugin
-----------------
=====================
Manage Beiran Cluster
=====================
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment