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

Docs/ Renamed "Before we start" section #310

Merged
merged 3 commits into from
Nov 22, 2019
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
4 changes: 2 additions & 2 deletions docs/permissions_compiler/glossary.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

def read_titles(level_char='='):
headings = []
with open('before_start/glossary.rst') as gfile:
with open('concepts_architecture/glossary.rst') as gfile:
lines = gfile.readlines()
prevline = ''
prevlen = 0
Expand All @@ -22,6 +22,6 @@ def titles_to_links(titles):
d = {}
for title in titles:
title = title.strip().lower()
anchor = '../../before_start/glossary.html#' + title.replace(' ', '-')
anchor = '../../concepts_architecture/glossary.html#' + title.replace(' ', '-')
d[title] = anchor
return d
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _before_start:
.. _concepts_architecture:

===============
Before we start
===============
=========================
Concepts and Architecture
=========================

Iroha is a system that can work with different concepts, and for your convenience we would like you to look through them so you could familiarise yourself with what you will be dealing with. That can be done in "Core concepts section".

Expand Down
6 changes: 3 additions & 3 deletions docs/source/develop/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ We will overview commands and queries that the system has, and the set of client
Iroha API follows command-query separation `principle <https://en.wikipedia.org/wiki/Command%E2%80%93query_separation>`_.

Communication between Iroha peer and a client application is maintained via `gRPC <https://grpc.io/about/>`_ framework.
Client applications should follow described protocol and form transactions accordingly to their `description <../before_start/glossary.html#transaction>`_.
Client applications should follow described protocol and form transactions accordingly to their `description <../concepts_architecture/glossary.html#transaction>`_.


.. toctree::
Expand All @@ -18,9 +18,9 @@ Client applications should follow described protocol and form transactions accor
api/queries.rst
api/permissions.rst

Commands here are parts of `transaction <../before_start/glossary.html#transaction>`_ - a state-changing set of actions in the system. When a transaction passes validation and consensus stages, it is written in a `block <../before_start/glossary.html#block>`_ and saved in immutable block store (blockchain).
Commands here are parts of `transaction <../concepts_architecture/glossary.html#transaction>`_ - a state-changing set of actions in the system. When a transaction passes validation and consensus stages, it is written in a `block <../concepts_architecture/glossary.html#block>`_ and saved in immutable block store (blockchain).

Transactions consist of commands, performing an action over an `entity <../before_start/er_model.html>`_ in the system. The entity might be an account, asset, etc.
Transactions consist of commands, performing an action over an `entity <../concepts_architecture/er_model.html>`_ in the system. The entity might be an account, asset, etc.



144 changes: 72 additions & 72 deletions docs/source/develop/api/permissions.rst

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/source/develop/api/queries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,8 @@ Get Pending Transactions
Purpose
-------

GetPendingTransactions is used for retrieving a list of pending (not fully signed) `multisignature transactions <../../before_start/glossary.html#multisignature-transactions>`_
or `batches of transactions <../../before_start/glossary.html#batch-of-transactions>`__ issued by account of query creator.
GetPendingTransactions is used for retrieving a list of pending (not fully signed) `multisignature transactions <../../concepts_architecture/glossary.html#multisignature-transactions>`_
or `batches of transactions <../../concepts_architecture/glossary.html#batch-of-transactions>`__ issued by account of query creator.

.. note:: This query uses pagination for quicker and more convenient query responses.

Expand Down Expand Up @@ -328,7 +328,7 @@ Response Schema
Response Structure
------------------

The response contains a list of `pending transactions <../../before_start/glossary.html#pending-transactions>`_,
The response contains a list of `pending transactions <../../concepts_architecture/glossary.html#pending-transactions>`_,
the amount of all stored pending transactions for the user
and the information required to query the subsequent page (if exists).

Expand All @@ -352,8 +352,8 @@ Get Pending Transactions (deprecated)
Purpose
-------

GetPendingTransactions is used for retrieving a list of pending (not fully signed) `multisignature transactions <../../before_start/glossary.html#multisignature-transactions>`_
or `batches of transactions <../../before_start/glossary.html#batch-of-transactions>`__ issued by account of query creator.
GetPendingTransactions is used for retrieving a list of pending (not fully signed) `multisignature transactions <../../concepts_architecture/glossary.html#multisignature-transactions>`_
or `batches of transactions <../../concepts_architecture/glossary.html#batch-of-transactions>`__ issued by account of query creator.

Request Schema
--------------
Expand All @@ -375,7 +375,7 @@ Response Schema
Response Structure
------------------

The response contains a list of `pending transactions <../../before_start/glossary.html#pending-transactions>`_.
The response contains a list of `pending transactions <../../concepts_architecture/glossary.html#pending-transactions>`_.

.. csv-table::
:header: "Field", "Description", "Constraint", "Example"
Expand Down
2 changes: 1 addition & 1 deletion docs/source/faq/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Hello, newcomer! You are very welcome :)
There are 2 ways for you to start with Iroha:

1. You can see what Iroha is an how it works by building a simple example network following our `Getting Started Guide <../getting_started/index.html>`_
2. You can get acquainted with the `core concepts of Iroha <../before_start/index.html>`_ and start building your own `Iroha network <../deploy/index.html>`_
2. You can get acquainted with the `core concepts of Iroha <../concepts_architecture/index.html>`_ and start building your own `Iroha network <../deploy/index.html>`_

Now you have your Iroha blockchain! Congratulations!
If you have any questions on it, do not hesitate to contact our community here: https://chat.hyperledger.org/channel/iroha
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ As Hyperledger Iroha is an open-source project, we will also cover contribution
:caption: Table of contents

overview.rst
before_start/index.rst
concepts_architecture/index.rst
getting_started/index.rst
integrations/index.rst
build/index.rst
Expand Down
2 changes: 1 addition & 1 deletion docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ How to create applications around Iroha?
----------------------------------------

In order to bring the power of blockchain into your application, you should think first of how it is going to interface with Iroha peers.
A good start is to check `Before we start section <before_start/index.html>`_, explaining what exactly is a transaction and query, and how users of your application are supposed to interact with it.
A good start is to check `Concepts and Architecture section <concepts_architecture/index.html>`_, explaining what exactly is a transaction and query, and how users of your application are supposed to interact with it.

We also have several client libraries which provide tools for developers to form building blocks, such as signatures, commands,
send messages to Iroha peers and check the status.