docs: fixed small wanrings/errors during build.
This commit is contained in:
parent
09d36e8196
commit
c152f31d62
16 changed files with 39 additions and 24 deletions
|
|
@ -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.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ changeset_comment
|
|||
|
||||
Example error output:
|
||||
|
||||
.. code-block:: json
|
||||
.. code-block:: bash
|
||||
|
||||
{
|
||||
"id" : <id_given_in_input>,
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ delete_repo_group
|
|||
|
||||
id : <id_given_in_input>
|
||||
result : {
|
||||
'msg': 'deleted repo group ID:<repogroupid> <repogroupname>
|
||||
'msg': 'deleted repo group ID:<repogroupid> <repogroupname>'
|
||||
'repo_group': null
|
||||
}
|
||||
error : null
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ comment_commit
|
|||
|
||||
Example error output:
|
||||
|
||||
.. code-block:: json
|
||||
.. code-block:: bash
|
||||
|
||||
{
|
||||
"id" : <id_given_in_input>,
|
||||
|
|
@ -125,7 +125,7 @@ create_repo
|
|||
id : <id_given_in_input>
|
||||
result : null
|
||||
error : {
|
||||
'failed to create repository `<repo_name>`
|
||||
'failed to create repository `<repo_name>`'
|
||||
}
|
||||
|
||||
|
||||
|
|
@ -729,7 +729,7 @@ lock
|
|||
id : <id_given_in_input>
|
||||
result : null
|
||||
error : {
|
||||
'Error occurred locking repository `<reponame>`
|
||||
'Error occurred locking repository `<reponame>`'
|
||||
}
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
|
||||
=====
|
||||
API
|
||||
=====
|
||||
===================
|
||||
CONTRIBUTING TO API
|
||||
===================
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
17
docs/contributing/checklist-pull-request.rst
Normal file
17
docs/contributing/checklist-pull-request.rst
Normal file
|
|
@ -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.
|
||||
|
||||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -9,9 +9,6 @@
|
|||
.. Avoid duplicating the quickstart instructions by importing the README
|
||||
file.
|
||||
|
||||
.. include:: ../../../acceptance_tests/README.rst
|
||||
|
||||
|
||||
|
||||
Choices of technology and tools
|
||||
===============================
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
BIN
docs/images/redmine-description.png
Normal file
BIN
docs/images/redmine-description.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
|
|
@ -50,3 +50,4 @@ See pages specific to each type of integration for more instructions:
|
|||
redmine
|
||||
jira
|
||||
webhook
|
||||
email
|
||||
|
|
|
|||
|
|
@ -606,7 +606,7 @@ def create_repo(request, apiuser, repo_name, repo_type,
|
|||
id : <id_given_in_input>
|
||||
result : null
|
||||
error : {
|
||||
'failed to create repository `<repo_name>`
|
||||
'failed to create repository `<repo_name>`'
|
||||
}
|
||||
|
||||
"""
|
||||
|
|
@ -1228,7 +1228,7 @@ def lock(request, apiuser, repoid, locked=Optional(None),
|
|||
id : <id_given_in_input>
|
||||
result : null
|
||||
error : {
|
||||
'Error occurred locking repository `<reponame>`
|
||||
'Error occurred locking repository `<reponame>`'
|
||||
}
|
||||
"""
|
||||
|
||||
|
|
|
|||
|
|
@ -321,7 +321,7 @@ def delete_repo_group(request, apiuser, repogroupid):
|
|||
|
||||
id : <id_given_in_input>
|
||||
result : {
|
||||
'msg': 'deleted repo group ID:<repogroupid> <repogroupname>
|
||||
'msg': 'deleted repo group ID:<repogroupid> <repogroupname>'
|
||||
'repo_group': null
|
||||
}
|
||||
error : null
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue