From 711278bd27c757d405f0df67f02bb07ef30f1cab Mon Sep 17 00:00:00 2001 From: Marcin Kuzminski Date: Thu, 29 Jun 2017 11:36:13 +0200 Subject: [PATCH] docs: small rst fixes. --- docs/admin/nginx-config-example.rst | 1 + docs/api/methods/deprecated-methods.rst | 6 +++--- docs/contributing/contributing.rst | 5 +++++ docs/integrations/ci.rst | 2 +- docs/integrations/integrations.rst | 1 + docs/tutorials/api-examples.rst | 5 ++--- 6 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/admin/nginx-config-example.rst b/docs/admin/nginx-config-example.rst index 7f55d38f..8f5438c4 100644 --- a/docs/admin/nginx-config-example.rst +++ b/docs/admin/nginx-config-example.rst @@ -5,6 +5,7 @@ Use the following example to configure Nginx as a your web server. .. code-block:: nginx + ## rate limiter for certain pages to prevent brute force attacks limit_req_zone $binary_remote_addr zone=dl_limit:10m rate=1r/s; diff --git a/docs/api/methods/deprecated-methods.rst b/docs/api/methods/deprecated-methods.rst index ea5f069f..25402f46 100644 --- a/docs/api/methods/deprecated-methods.rst +++ b/docs/api/methods/deprecated-methods.rst @@ -38,13 +38,13 @@ changeset_comment Example error output: - .. code-block:: json + .. code-block:: javascript { - "id" : , + "id" : "", "result" : { "msg": "Commented on commit `` for repository ``", - "status_change": null or , + "status_change": null or "", "success": true }, "error" : null diff --git a/docs/contributing/contributing.rst b/docs/contributing/contributing.rst index 89d58e7e..3f3b19d9 100644 --- a/docs/contributing/contributing.rst +++ b/docs/contributing/contributing.rst @@ -19,3 +19,8 @@ Welcome to the contribution guides and development docs of RhodeCode. dev-settings api dependencies + checklist-tickets + checklist-pull-request + frontend + standards + diff --git a/docs/integrations/ci.rst b/docs/integrations/ci.rst index 7f5bca4e..adfd00f5 100644 --- a/docs/integrations/ci.rst +++ b/docs/integrations/ci.rst @@ -35,7 +35,7 @@ call for unspecified builds. A quick note on security. It's recommended to allow IP restrictions to only allow RhodeCode server to trigger builds. If you need to specify username and password this could be done by embedding it into a - trigger URL, e.g. `http://user:password@server.com/job/${project_id} + trigger URL, e.g. `http://user:password@server.com/job/${project_id}` If users require to provide any custom parameters, they can be stored for each diff --git a/docs/integrations/integrations.rst b/docs/integrations/integrations.rst index 9cb4f9e1..64b5dfe0 100644 --- a/docs/integrations/integrations.rst +++ b/docs/integrations/integrations.rst @@ -52,3 +52,4 @@ See pages specific to each type of integration for more instructions: jira webhook email + ci diff --git a/docs/tutorials/api-examples.rst b/docs/tutorials/api-examples.rst index bef1caa5..f6a48982 100644 --- a/docs/tutorials/api-examples.rst +++ b/docs/tutorials/api-examples.rst @@ -48,14 +48,13 @@ the following steps: # Check the JSON-RPC verification -.. code-block:: jsonld +.. code-block:: javascript { "error": null, "id": 5960, "result": { - "msg": "Stripped commit ad1e0523a4ab from - repo `repo-group/repo-name`", + "msg": "Stripped commit ad1e0523a4ab from repo `repo-group/repo-name`", "repository": "repo-group/repo-name" } }