##// END OF EJS Templates
docs: fixed small wanrings/errors during build.
marcink -
r1120:d4155363 default
parent child Browse files
Show More
@@ -0,0 +1,17 b''
1 .. _checklist-pull-request:
2
3 =======================
4 Pull Request Checklists
5 =======================
6
7
8
9 Checklists for Pull Request
10 ===========================
11
12
13 - Informative description
14 - Linear commit history
15 - Rebased on top of latest changes
16 - Add ticket references. eg fixes #123, references #123 etc.
17
1 NO CONTENT: new file 100644, binary diff hidden
NO CONTENT: new file 100644, binary diff hidden
@@ -127,10 +127,10 b' system use the following steps.'
127
127
128 1. Install a new instance of |RCE| using sqlite option as database.
128 1. Install a new instance of |RCE| using sqlite option as database.
129 2. Restore your database.
129 2. Restore your database.
130 2. Once installed, replace you backed up the :file:`rhodecode.ini` with your
130 3. Once installed, replace you backed up the :file:`rhodecode.ini` with your
131 backup version. Ensure this file points to the restored
131 backup version. Ensure this file points to the restored
132 database, see the :ref:`config-database` section.
132 database, see the :ref:`config-database` section.
133 3. Restart |RCE| and remap and rescan your |repos| to verify filesystem access,
133 4. Restart |RCE| and remap and rescan your |repos| to verify filesystem access,
134 see the :ref:`remap-rescan` section.
134 see the :ref:`remap-rescan` section.
135
135
136
136
@@ -36,7 +36,7 b' 1. On your local machine create the publ'
36 Your public key has been saved in /home/user/.ssh/id_rsa.pub.
36 Your public key has been saved in /home/user/.ssh/id_rsa.pub.
37 The key fingerprint is:
37 The key fingerprint is:
38 02:82:38:95:e5:30:d2:ad:17:60:15:7f:94:17:9f:30 user@ubuntu
38 02:82:38:95:e5:30:d2:ad:17:60:15:7f:94:17:9f:30 user@ubuntu
39 The key's randomart image is:
39 The key\'s randomart image is:
40 +--[ RSA 2048]----+
40 +--[ RSA 2048]----+
41
41
42 2. SFTP to your server, and copy the public key to the ``~/.ssh`` folder.
42 2. SFTP to your server, and copy the public key to the ``~/.ssh`` folder.
@@ -18,7 +18,7 b' 1. Open ishell from the terminal and use'
18 2. Run the following commands, and ensure that |RCE| has write access to the
18 2. Run the following commands, and ensure that |RCE| has write access to the
19 new directory:
19 new directory:
20
20
21 .. code-block:: mysql
21 .. code-block:: bash
22
22
23 # Once logged into the database, use SQL to redirect
23 # Once logged into the database, use SQL to redirect
24 # the large files location
24 # the large files location
@@ -38,7 +38,7 b' changeset_comment'
38
38
39 Example error output:
39 Example error output:
40
40
41 .. code-block:: json
41 .. code-block:: bash
42
42
43 {
43 {
44 "id" : <id_given_in_input>,
44 "id" : <id_given_in_input>,
@@ -4,7 +4,7 b' license methods'
4 ===============
4 ===============
5
5
6 get_license_info (EE only)
6 get_license_info (EE only)
7 ----------------
7 --------------------------
8
8
9 .. py:function:: get_license_info(apiuser)
9 .. py:function:: get_license_info(apiuser)
10
10
@@ -32,7 +32,7 b' get_license_info (EE only)'
32
32
33
33
34 set_license_key (EE only)
34 set_license_key (EE only)
35 ---------------
35 -------------------------
36
36
37 .. py:function:: set_license_key(apiuser, key)
37 .. py:function:: set_license_key(apiuser, key)
38
38
@@ -73,7 +73,7 b' delete_repo_group'
73
73
74 id : <id_given_in_input>
74 id : <id_given_in_input>
75 result : {
75 result : {
76 'msg': 'deleted repo group ID:<repogroupid> <repogroupname>
76 'msg': 'deleted repo group ID:<repogroupid> <repogroupname>'
77 'repo_group': null
77 'repo_group': null
78 }
78 }
79 error : null
79 error : null
@@ -48,7 +48,7 b' comment_commit'
48
48
49 Example error output:
49 Example error output:
50
50
51 .. code-block:: json
51 .. code-block:: bash
52
52
53 {
53 {
54 "id" : <id_given_in_input>,
54 "id" : <id_given_in_input>,
@@ -125,7 +125,7 b' create_repo'
125 id : <id_given_in_input>
125 id : <id_given_in_input>
126 result : null
126 result : null
127 error : {
127 error : {
128 'failed to create repository `<repo_name>`
128 'failed to create repository `<repo_name>`'
129 }
129 }
130
130
131
131
@@ -729,7 +729,7 b' lock'
729 id : <id_given_in_input>
729 id : <id_given_in_input>
730 result : null
730 result : null
731 error : {
731 error : {
732 'Error occurred locking repository `<reponame>`
732 'Error occurred locking repository `<reponame>`'
733 }
733 }
734
734
735
735
@@ -1,7 +1,7 b''
1
1
2 =====
2 ===================
3 API
3 CONTRIBUTING TO API
4 =====
4 ===================
5
5
6
6
7
7
@@ -130,7 +130,7 b' is a very small pencil which has to be c'
130 ticket.
130 ticket.
131
131
132
132
133 .. figure:: images/redmine-description.png
133 .. figure:: ../images/redmine-description.png
134 :alt: Example of pencil to change the ticket description
134 :alt: Example of pencil to change the ticket description
135
135
136 Shows an example of the pencil which lets you change the description.
136 Shows an example of the pencil which lets you change the description.
@@ -9,9 +9,6 b''
9 .. Avoid duplicating the quickstart instructions by importing the README
9 .. Avoid duplicating the quickstart instructions by importing the README
10 file.
10 file.
11
11
12 .. include:: ../../../acceptance_tests/README.rst
13
14
15
12
16 Choices of technology and tools
13 Choices of technology and tools
17 ===============================
14 ===============================
@@ -88,10 +88,10 b' let'
88 };
88 };
89
89
90 Sphinx = buildPythonPackage (rec {
90 Sphinx = buildPythonPackage (rec {
91 name = "Sphinx-1.4.4";
91 name = "Sphinx-1.4.8";
92 src = fetchurl {
92 src = fetchurl {
93 url = "https://pypi.python.org/packages/20/a2/72f44c84f6c4115e3fef58d36d657ec311d80196eab9fd5ec7bcde76143b/${name}.tar.gz";
93 url = "https://pypi.python.org/packages/1f/f6/e54a7aad73e35232356103771ae76306dadd8546b024c646fbe75135571c/${name}.tar.gz";
94 md5 = "64ce2ec08d37ed56313a98232cbe2aee";
94 md5 = "5ec718a4855917e149498bba91b74e67";
95 };
95 };
96 propagatedBuildInputs = [
96 propagatedBuildInputs = [
97 docutils
97 docutils
@@ -50,3 +50,4 b' See pages specific to each type of integ'
50 redmine
50 redmine
51 jira
51 jira
52 webhook
52 webhook
53 email
@@ -606,7 +606,7 b' def create_repo(request, apiuser, repo_n'
606 id : <id_given_in_input>
606 id : <id_given_in_input>
607 result : null
607 result : null
608 error : {
608 error : {
609 'failed to create repository `<repo_name>`
609 'failed to create repository `<repo_name>`'
610 }
610 }
611
611
612 """
612 """
@@ -1228,7 +1228,7 b' def lock(request, apiuser, repoid, locke'
1228 id : <id_given_in_input>
1228 id : <id_given_in_input>
1229 result : null
1229 result : null
1230 error : {
1230 error : {
1231 'Error occurred locking repository `<reponame>`
1231 'Error occurred locking repository `<reponame>`'
1232 }
1232 }
1233 """
1233 """
1234
1234
@@ -321,7 +321,7 b' def delete_repo_group(request, apiuser, '
321
321
322 id : <id_given_in_input>
322 id : <id_given_in_input>
323 result : {
323 result : {
324 'msg': 'deleted repo group ID:<repogroupid> <repogroupname>
324 'msg': 'deleted repo group ID:<repogroupid> <repogroupname>'
325 'repo_group': null
325 'repo_group': null
326 }
326 }
327 error : null
327 error : null
General Comments 0
You need to be logged in to leave comments. Login now