diff --git a/docs/admin/backup-restore.rst b/docs/admin/backup-restore.rst index aa2bad71..e5e0d8bf 100644 --- a/docs/admin/backup-restore.rst +++ b/docs/admin/backup-restore.rst @@ -127,10 +127,10 @@ system use the following steps. 1. Install a new instance of |RCE| using sqlite option as database. 2. Restore your database. -2. Once installed, replace you backed up the :file:`rhodecode.ini` with your +3. Once installed, replace you backed up the :file:`rhodecode.ini` with your backup version. Ensure this file points to the restored database, see the :ref:`config-database` section. -3. Restart |RCE| and remap and rescan your |repos| to verify filesystem access, +4. Restart |RCE| and remap and rescan your |repos| to verify filesystem access, see the :ref:`remap-rescan` section. diff --git a/docs/admin/sec-your-server.rst b/docs/admin/sec-your-server.rst index 02ff834e..b8808c38 100644 --- a/docs/admin/sec-your-server.rst +++ b/docs/admin/sec-your-server.rst @@ -36,7 +36,7 @@ following steps: Your public key has been saved in /home/user/.ssh/id_rsa.pub. The key fingerprint is: 02:82:38:95:e5:30:d2:ad:17:60:15:7f:94:17:9f:30 user@ubuntu - The key's randomart image is: + The key\'s randomart image is: +--[ RSA 2048]----+ 2. SFTP to your server, and copy the public key to the ``~/.ssh`` folder. diff --git a/docs/admin/tuning-change-large-file-dir.rst b/docs/admin/tuning-change-large-file-dir.rst index 74ba0519..05edb35e 100644 --- a/docs/admin/tuning-change-large-file-dir.rst +++ b/docs/admin/tuning-change-large-file-dir.rst @@ -18,7 +18,7 @@ the following steps: 2. Run the following commands, and ensure that |RCE| has write access to the new directory: -.. code-block:: mysql +.. code-block:: bash # Once logged into the database, use SQL to redirect # the large files location diff --git a/docs/api/methods/deprecated-methods.rst b/docs/api/methods/deprecated-methods.rst index ea5f069f..d82ef28b 100644 --- a/docs/api/methods/deprecated-methods.rst +++ b/docs/api/methods/deprecated-methods.rst @@ -38,7 +38,7 @@ changeset_comment Example error output: - .. code-block:: json + .. code-block:: bash { "id" : , diff --git a/docs/api/methods/license-methods.rst b/docs/api/methods/license-methods.rst index e29d92e9..8c7f918b 100644 --- a/docs/api/methods/license-methods.rst +++ b/docs/api/methods/license-methods.rst @@ -4,7 +4,7 @@ license methods =============== get_license_info (EE only) ----------------- +-------------------------- .. py:function:: get_license_info(apiuser) @@ -32,7 +32,7 @@ get_license_info (EE only) set_license_key (EE only) ---------------- +------------------------- .. py:function:: set_license_key(apiuser, key) diff --git a/docs/api/methods/repo-group-methods.rst b/docs/api/methods/repo-group-methods.rst index fb4fe4b7..fb4dcef7 100644 --- a/docs/api/methods/repo-group-methods.rst +++ b/docs/api/methods/repo-group-methods.rst @@ -73,7 +73,7 @@ delete_repo_group id : result : { - 'msg': 'deleted repo group ID: + 'msg': 'deleted repo group ID: ' 'repo_group': null } error : null diff --git a/docs/api/methods/repo-methods.rst b/docs/api/methods/repo-methods.rst index ae55e8ad..afcb619d 100644 --- a/docs/api/methods/repo-methods.rst +++ b/docs/api/methods/repo-methods.rst @@ -48,7 +48,7 @@ comment_commit Example error output: - .. code-block:: json + .. code-block:: bash { "id" : , @@ -125,7 +125,7 @@ create_repo id : result : null error : { - 'failed to create repository `` + 'failed to create repository ``' } @@ -729,7 +729,7 @@ lock id : result : null error : { - 'Error occurred locking repository `` + 'Error occurred locking repository ``' } diff --git a/docs/contributing/api.rst b/docs/contributing/api.rst index fd311bd6..205a55a4 100644 --- a/docs/contributing/api.rst +++ b/docs/contributing/api.rst @@ -1,7 +1,7 @@ -===== - API -===== +=================== +CONTRIBUTING TO API +=================== diff --git a/docs/contributing/checklist-pull-request.rst b/docs/contributing/checklist-pull-request.rst new file mode 100644 index 00000000..eca141c8 --- /dev/null +++ b/docs/contributing/checklist-pull-request.rst @@ -0,0 +1,17 @@ +.. _checklist-pull-request: + +======================= +Pull Request Checklists +======================= + + + +Checklists for Pull Request +=========================== + + +- Informative description +- Linear commit history +- Rebased on top of latest changes +- Add ticket references. eg fixes #123, references #123 etc. + diff --git a/docs/contributing/checklist-tickets.rst b/docs/contributing/checklist-tickets.rst index f04f9194..86815c6a 100644 --- a/docs/contributing/checklist-tickets.rst +++ b/docs/contributing/checklist-tickets.rst @@ -130,7 +130,7 @@ is a very small pencil which has to be clicked once you see the edit form of a ticket. -.. figure:: images/redmine-description.png +.. figure:: ../images/redmine-description.png :alt: Example of pencil to change the ticket description Shows an example of the pencil which lets you change the description. diff --git a/docs/contributing/testing/spec-by-example.rst b/docs/contributing/testing/spec-by-example.rst index 00cc259a..25db322d 100644 --- a/docs/contributing/testing/spec-by-example.rst +++ b/docs/contributing/testing/spec-by-example.rst @@ -9,9 +9,6 @@ .. Avoid duplicating the quickstart instructions by importing the README file. -.. include:: ../../../acceptance_tests/README.rst - - Choices of technology and tools =============================== diff --git a/docs/default.nix b/docs/default.nix index 3e320f50..88e22318 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -88,10 +88,10 @@ let }; Sphinx = buildPythonPackage (rec { - name = "Sphinx-1.4.4"; + name = "Sphinx-1.4.8"; src = fetchurl { - url = "https://pypi.python.org/packages/20/a2/72f44c84f6c4115e3fef58d36d657ec311d80196eab9fd5ec7bcde76143b/${name}.tar.gz"; - md5 = "64ce2ec08d37ed56313a98232cbe2aee"; + url = "https://pypi.python.org/packages/1f/f6/e54a7aad73e35232356103771ae76306dadd8546b024c646fbe75135571c/${name}.tar.gz"; + md5 = "5ec718a4855917e149498bba91b74e67"; }; propagatedBuildInputs = [ docutils diff --git a/docs/images/redmine-description.png b/docs/images/redmine-description.png new file mode 100644 index 00000000..cd473f66 Binary files /dev/null and b/docs/images/redmine-description.png differ diff --git a/docs/integrations/integrations.rst b/docs/integrations/integrations.rst index b7d95c83..8a705e2d 100644 --- a/docs/integrations/integrations.rst +++ b/docs/integrations/integrations.rst @@ -50,3 +50,4 @@ See pages specific to each type of integration for more instructions: redmine jira webhook + email diff --git a/rhodecode/api/views/repo_api.py b/rhodecode/api/views/repo_api.py index 658e6bf2..e756ae7f 100644 --- a/rhodecode/api/views/repo_api.py +++ b/rhodecode/api/views/repo_api.py @@ -606,7 +606,7 @@ def create_repo(request, apiuser, repo_name, repo_type, id : result : null error : { - 'failed to create repository `` + 'failed to create repository ``' } """ @@ -1228,7 +1228,7 @@ def lock(request, apiuser, repoid, locked=Optional(None), id : result : null error : { - 'Error occurred locking repository `` + 'Error occurred locking repository ``' } """ diff --git a/rhodecode/api/views/repo_group_api.py b/rhodecode/api/views/repo_group_api.py index a2533839..e062186f 100644 --- a/rhodecode/api/views/repo_group_api.py +++ b/rhodecode/api/views/repo_group_api.py @@ -321,7 +321,7 @@ def delete_repo_group(request, apiuser, repogroupid): id : result : { - 'msg': 'deleted repo group ID: + 'msg': 'deleted repo group ID: ' 'repo_group': null } error : null