Skip to content
This repository has been archived by the owner on Jan 29, 2022. It is now read-only.

1.2.0 Documentation Turkish Translation #12

Merged
merged 5 commits into from
Sep 17, 2020
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
214 changes: 214 additions & 0 deletions docs/locale/tr/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
.. contents:: **Table of Contents**
:depth: 3

First off, thanks for taking the time to contribute!

The following is a short set of guidelines for contributing to Iroha.

How Can I Contribute?
---------------------

Reporting Bugs
~~~~~~~~~~~~~~

*Bug* is an error, design flaw, failure or fault in Iroha that causes it
to produce an incorrect or unexpected result, or to behave in unintended
ways.

Bugs are tracked as `JIRA
issues <https://jira.hyperledger.org/projects/IR/issues/IR-275?filter=allopenissues&orderby=issuetype+ASC%2C+priority+DESC%2C+updated+DESC>`__
in Hyperledger Jira.

To submit a bug, `create new
issue <https://jira.hyperledger.org/secure/CreateIssue.jspa>`__ and
include these details:

+---------------------+------------------------------------------------------+
| Field | What to enter |
+=====================+======================================================+
| Project | Iroha (IR) |
+---------------------+------------------------------------------------------+
| Issue Type | Bug |
+---------------------+------------------------------------------------------+
| Summary | Essence of the problem |
+---------------------+------------------------------------------------------+
| Description | What the issue is about; if you have any logs, |
| | please provide them |
+---------------------+------------------------------------------------------+
| Priority | You can use Medium though if you see the issue as a |
| | high priority, please choose that |
+---------------------+------------------------------------------------------+
| Environment | Your OS, device's specs, Virtual Environment if you |
| | use one, version of Iroha etc. |
+---------------------+------------------------------------------------------+

Reporting Vulnerabilities
~~~~~~~~~~~~~~~~~~~~~~~~~

While we try to be proactive in preventing security problems, we do not
assume they?ll never come up.

It is standard practice to responsibly and privately disclose to the
vendor (Hyperledger organization) a security problem before publicizing,
so a fix can be prepared, and damage from the vulnerability minimized.

Before the First Major Release (1.0) all vulnerabilities are considered
to be bugs, so feel free to submit them as described above. After the
First Major Release please utilize `a bug bounty program
here <https://hackerone.com/hyperledger>`__ in order to submit
vulnerabilities and get your reward.

In any case ? feel free to reach to any of existing maintainers in
Rocket.Chat private messages or in an e-mail (check CONTRIBUTORS.md
file) if you want to discuss whether your discovery is a vulnerability
or a bug.

Suggesting Improvements
~~~~~~~~~~~~~~~~~~~~~~~

An *improvement* is a code or idea, which makes **existing** code or
design faster, more stable, portable, secure or better in any other way.

Improvements are tracked as `JIRA
improvements <https://jira.hyperledger.org/browse/IR-184?jql=project%20%3D%20IR%20and%20issuetype%20%3D%20Improvement%20ORDER%20BY%20updated%20DESC>`__.
To submit new improvement, `create new
issue <https://jira.hyperledger.org/secure/CreateIssue.jspa>`__ and
include these details:

+---------------------+------------------------------------------------------+
| Field | What to enter |
+=====================+======================================================+
| Project | Iroha (IR) |
+---------------------+------------------------------------------------------+
| Issue Type | Improvement |
+---------------------+------------------------------------------------------+
| Summary | Essence of the idea |
+---------------------+------------------------------------------------------+
| Description | What the idea is about; if you have any code |
| | suggestions, you are welcome to add them here |
+---------------------+------------------------------------------------------+
| Priority | You can use Medium |
+---------------------+------------------------------------------------------+
| Assign | You can assign the task to yourself if you are |
| | planning on working on it |
+---------------------+------------------------------------------------------+

Asking Questions
~~~~~~~~~~~~~~~~

A *question* is any discussion that is typically neigher a bug, nor
feature request or improvement. If you have a question like "How do I do
X?" - this paragraph is for you.

Please post your question in `your favourite
messenger <#places-where-community-is-active>`__ so members of the
community could help you. You can also help others!

Your First Code Contribution
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Read our `C++ Style Guide <#c-style-guide>`__ and start with
beginner-friendly issues with JIRA label
`good-first-issue <https://jira.hyperledger.org/issues/?jql=project%20%3D%20IR%20and%20labels%20%3D%20good-first-issue%20ORDER%20BY%20updated%20DESC>`__.
Indicate somehow that you are working on this task: get in touch with
maintainers team, community or simply assign this issue to yourself.

Pull Requests
~~~~~~~~~~~~~

- Fill in `the required template <https://github.com/hyperledger/iroha/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`__

- End all files with a newline

- **Write tests** for new code. Test coverage for new code must be at
least 70%

- Every pull request should be reviewed and **get at least two
approvals from maintainers team**. Check who is a current maintainer
in
`MAINTAINERS.md <https://github.com/hyperledger/iroha/blob/master/MAINTAINERS.md>`__
file

- When you've finished work make sure that you've got all passing CI
checks ? after that **squash and merge** your pull request

- Follow the `C++ Style Guide <#c-style-guide>`__

- Follow the `Git Style Guide <#git-style-guide>`__

- **Document new code** based on the `Documentation
Styleguide <#documentation-styleguide>`__

- When working with **PRs from forks** check `this
manual <https://help.github.com/articles/checking-out-pull-requests-locally>`__

Styleguides
-----------

Git Style Guide
~~~~~~~~~~~~~~~

- **Sign-off every commit** with `DCO <https://github.com/apps/dco>`__:
``Signed-off-by: $NAME <$EMAIL>``. You can do it automatically using
``git commit -s``
- **Use present tense** ("Add feature", not "Added feature").
- **Use imperative mood** ("Deploy docker to..." not "Deploys docker
to...").
- Write meaningful commit message.
- Limit the first line of commit message to 50 characters or less
- First line of commit message must contain summary of work done,
second line must contain empty line, third and other lines can
contain list of commit changes

C++ Style Guide
~~~~~~~~~~~~~~~

- Use clang-format
`settings <https://github.com/hyperledger/iroha/blob/master/.clang-format>`__
file. There are guides available on the internet (e.g. `Kratos
wiki <https://github.com/KratosMultiphysics/Kratos/wiki/How-to-configure-clang%E2%80%90format>`__)
- Follow
`CppCoreGuidelines <http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines>`__
and `Cpp Best
Practices <https://lefticus.gitbooks.io/cpp-best-practices>`__.
- Avoid
`platform-dependent <https://stackoverflow.com/questions/1558194/learning-and-cross-platform-development-c>`__
code.
- Use `C++17 <https://en.wikipedia.org/wiki/C%2B%2B17>`__.
- Use `camelCase <https://en.wikipedia.org/wiki/Camel_case>`__ for
class names and methods, use
`snake\_case <https://en.wikipedia.org/wiki/Snake_case>`__ for
variables.

Documentation Styleguide
~~~~~~~~~~~~~~~~~~~~~~~~

- Use
`Doxygen <http://www.doxygen.nl/>`__.
- Document all public API: methods, functions, members, templates,
classes...

Places where community is active
--------------------------------

Our community members are active at:

+----------------+-------------------------------------------------------------+
| Service | Link |
+================+=============================================================+
| RocketChat | https://chat.hyperledger.org/channel/iroha |
+----------------+-------------------------------------------------------------+
| StackOverflow | https://stackoverflow.com/questions/tagged/hyperledger-iroha|
+----------------+-------------------------------------------------------------+
| Mailing List | hyperledger-iroha@lists.hyperledger.org |
+----------------+-------------------------------------------------------------+
| Gitter | https://gitter.im/hyperledger-iroha/Lobby |
+----------------+-------------------------------------------------------------+
| Telegram | https://t.me/hl\_iroha |
+----------------+-------------------------------------------------------------+
| YouTube | https://www.youtube.com/channel/UCYlK9OrZo9hvNYFuf0vrwww |
+----------------+-------------------------------------------------------------+

--------------

Thank you for reading the document!
1 change: 1 addition & 0 deletions docs/locale/tr/docs/.gitignore
40 changes: 40 additions & 0 deletions docs/locale/tr/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Iroha reStructuredTest Dökümantasyonu

Bu dökümanın amacı Iroha defterinin işlevsel tarafı kadar dizaynı ve mimari yönlerini yapısal bir yaklaşım içinde aktarmaktır: 'nasıl yapılır'ları, kılavuzları ve örnekleri. Dökümana ReadTheDocs websitesi aracılığıyla ulaşılabilir ve Sphinx'te mevcut olan birçok formata türetilebilir. Katkıda bulunmak için [reStructuredTest](http://docutils.sourceforge.net/rst.html) sözdizimine aşina olunmalı ve dosyada tanımlanan ilkeler takip edilmelidir.

## İlkeler

* sadece `image_assets` ve `source` dosyalarının içeriğini değiştir
* `source/permissions` dosyasında herhangi bir değişiklik olması durumunda `yetkilendirme ayarları` yapılmalıdır
* eğer yeni bölüm/dosya eklenirse — içindekilere eklenmelidir
* eğer herhangi yeni ilke eklenirse — öncelikle GitHub konularında bir geliştirme önerisi olarak tartışılmalıdır
* bizim yerel dosyalarımız resim varlıklarına veya diğer kaynaklara bağıntılı yolu kullanamayacağı için GitHub download linki veya harici bir servis kullanarak resimlere veya varlıklara referans vermek

## Kurulum

Genellikle dökümanlara ReadTheDocs websitesi üzerinden erişilebilir. Sonucun yerel olarak kontrol edilmesine rağmen, bu rutinleri takip ederek manuel bir şekilde kurabilirsiniz:

### Önkoşullar

* Python 2.7 veya Python 3.3+, ve pip'in kurulmuş olması
* [Sphinx](http://www.sphinx-doc.org/en/stable/install.html)'in kurulu olması
* Dökümanın/kaynağın içinde `pip install -r requirements.txt` çalıştırılması

### Kurulum Adımları

1. `cd docs/source`
1. `make permissions`
1. `make html`

Bundan sonra döküman `_build` dosyasının içinde html formatında oluşturulur. Diğer formatları Sphinx websitesinden veya sadece `make` yazarak kontrol edebilirsiniz. Projede kullanılan temanın sözdizimine aşina olmak için lütfen [demo websitesine](https://sphinx-rtd-theme.readthedocs.io/en/latest/demo/demo.html) gidin

### Hedef dil için dökümanın versiyonu nasıl oluşturulur

Esas itibarıyla döküman oluşturmanın akışı [Sphinx dökümanının](http://www.sphinx-doc.org/en/stable/intl.html#id1) sayfasında tanımlanmıştır. Kısacası, alttaki adımlar uygulanmalıdır:

1. `pip install sphinx-intl`
1. Orijinal ingilizce kaynak testinin her düzeltmesi için, `gettext` komutu burada olduğu gibi çağrılmalıdır: `make gettext`
1. Sphinx-intl ikilisini çağıran döküman için yerel ayarı güncelleme/yaratma: `sphinx-intl update -p _build/gettext -l de -l ja`, komutu Japonca ve Almanca yerel dosyaları yaratır.
1. Hedef proje bu komut ile oluşturulur `make -e SPHINXOPTS="-D language='de'" html` (Almanca için)

Mac'te `sphinx-intl` ikilisi ile ilgili sorunlar var mı? PATH'e ekleyip eklemediğinizi kontrol edin, genellikle bu şekilde olmalıdır: `$PATH:$HOME/Library/Python/2.7/bin`.
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/Iroha_3.svg
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/Iroha_3_sm.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/block.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/burrow/natives.svg
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/er-model.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/icons/contributing.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/icons/docs.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/icons/how-to.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/iroha_header.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/iroha_logo.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/iroha_logo_doxygen.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/model-explained.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/pipeline-diagram.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/transaction-diagram.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/transaction_status.sketch
1 change: 1 addition & 0 deletions docs/locale/tr/docs/image_assets/tx_status.png
1 change: 1 addition & 0 deletions docs/locale/tr/docs/source/.gitignore
1 change: 1 addition & 0 deletions docs/locale/tr/docs/source/Makefile
1 change: 1 addition & 0 deletions docs/locale/tr/docs/source/_static/theme_overrides.css
Loading