Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
barseghyanartur committed Dec 22, 2019
1 parent c8b9a4b commit 0f41089
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 14 deletions.
23 changes: 16 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,15 +150,24 @@ Jira integration
----------------
It's possible to fetch ticket title and description from Jira. In order for it
to work, you should provide a ``fetch-title`` and ``fetch-description``
arguments:
arguments.

.. code-block:: sh
The following needs to be added to your ``.matyan.ini``:

generate-changelog --show-releases --fetch-title --fetch-description
.. code-block:: text
In adddition to that, you should put valid Jira credentials into your
[Settings]
fetchDataFrom=Jira
In addition to that, you should put valid Jira credentials into your
global ``.matyan.ini`` configuration file.

Command to run:

.. code-block:: sh
generate-changelog --show-releases --fetch-title --fetch-description
Configuration
=============
In order to customize names and texts, add a ``.matyan.ini`` in your
Expand Down Expand Up @@ -196,9 +205,9 @@ Sample configuration:
Note, that placing ``.matyan.ini`` into the home root will make that
configuration global for all projects. That's however is handy, since local
``.matyan.ini`` files simply override the global ones. You could use global
configuration for instance for storing credentials to Jira.
configuration global for all projects. That however could be handy, since local
``.matyan.ini`` files simply override the global ones. For example, you could
use global configuration for storing Jira credentials.

.. code-block:: text
Expand Down
23 changes: 16 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,15 +150,24 @@ Jira integration
----------------
It's possible to fetch ticket title and description from Jira. In order for it
to work, you should provide a ``fetch-title`` and ``fetch-description``
arguments:
arguments.

.. code-block:: sh
The following needs to be added to your ``.matyan.ini``:

generate-changelog --show-releases --fetch-title --fetch-description
.. code-block:: text
In adddition to that, you should put valid Jira credentials into your
[Settings]
fetchDataFrom=Jira
In addition to that, you should put valid Jira credentials into your
global ``.matyan.ini`` configuration file.

Command to run:

.. code-block:: sh
generate-changelog --show-releases --fetch-title --fetch-description
Configuration
=============
In order to customize names and texts, add a ``.matyan.ini`` in your
Expand Down Expand Up @@ -196,9 +205,9 @@ Sample configuration:
Note, that placing ``.matyan.ini`` into the home root will make that
configuration global for all projects. That's however is handy, since local
``.matyan.ini`` files simply override the global ones. You could use global
configuration for instance for storing credentials to Jira.
configuration global for all projects. That however could be handy, since local
``.matyan.ini`` files simply override the global ones. For example, you could
use global configuration for storing Jira credentials.

.. code-block:: text
Expand Down

0 comments on commit 0f41089

Please sign in to comment.