docs: updated documentation structure

docs/admin/repo-admin.rst

@@ -1,3 +1,4 @@
+.. _repo-admin-set:
 .. _permissions-info-add-group-ref:
 
 Repository Administration
@@ -18,9 +19,10 @@ settings for your needs:
 
 .. toctree::
 
-    repo-perm-steps
-    repo-extra-fields
-    repo-hooks
-    repo-issue-tracker
-    repo-vcs
-
+    repo_admin/repo-perm-steps
+    repo_admin/repo-extra-fields
+    repo_admin/repo-hooks
+    repo_admin/repo-issue-tracker
+    repo_admin/repo-vcs
+    repo_admin/restore-deleted-repositories
+    repo_admin/repo-admin-tasks

docs/admin/repo_admin/repo-admin-tasks.rst

@@ -0,0 +1,24 @@
+.. _repo-admin-tasks:
+
+Common Admin Tasks for Repositories
+-----------------------------------
+
+
+Manually Force Delete Repository
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In case of attached forks or pull-requests repositories should be archived.
+Here is how to force delete a repository and remove all dependent objects
+
+
+.. code-block:: bash
+
+    # starts the ishell interactive prompt
+    $ rccontrol ishell enterprise-1
+
+.. code-block:: python
+
+    In [4]: from rhodecode.model.repo import RepoModel
+    In [3]: repo = Repository.get_by_repo_name('test_repos/repo_with_prs')
+    In [5]: RepoModel().delete(repo, forks='detach', pull_requests='delete')
+    In [6]: Session().commit()

docs/admin/repo_admin/repo-extra-fields.rst

@@ -29,7 +29,7 @@ To configure extra fields per repository, use the following steps:
    beside the |repo| to which you wish to add extra fields.
 2. On the |repo| settings page, select the :guilabel:`Extra fields` tab.
 
-.. image:: ../images/extra-repo-fields.png
+.. image:: ../../images/extra-repo-fields.png
 
 The most important is the `New field key` variable which under the value will
 be stored. It needs to be unique for each repository. The label and description

docs/admin/system-admin.rst

@@ -16,19 +16,17 @@ The following are the most common system administration tasks.
 
 .. toctree::
 
-    config-files-overview
-    vcs-server
-    svn-http
-    svn-path-permissions
-    gunicorn-ssl-support
-    apache-config
-    nginx-config
-    backup-restore
-    tuning-rhodecode
-    indexing
-    reset-information
-    enable-debug
-    admin-tricks
-    cleanup-cmds
-    restore-deleted-repositories
-
+    system_admin/config-files-overview
+    system_admin/vcs-server
+    system_admin/svn-http
+    system_admin/svn-path-permissions
+    system_admin/gunicorn-ssl-support
+    system_admin/apache-config
+    system_admin/nginx-config
+    system_admin/backup-restore
+    system_admin/tuning-rhodecode
+    system_admin/indexing
+    system_admin/reset-information
+    system_admin/enable-debug
+    system_admin/admin-tricks
+    system_admin/cleanup-cmds

docs/admin/system_admin/admin-tricks.rst

@@ -57,7 +57,7 @@ you can add a message to be displayed using the following steps:
 3. Select :guilabel:`Save`, and you will see the message once your page
    refreshes.
 
-.. image:: ../images/server-wide-announcement.png
+.. image:: ../../images/server-wide-announcement.png
    :alt: Server Wide Announcement
 
 .. _md-rst:
@@ -207,7 +207,7 @@ do this, use the following steps.
    Instance "enterprise-2" successfully stopped.
    Instance "enterprise-2" successfully started.
 
-.. image:: ../images/language.png
+.. image:: ../../images/language.png
 
 .. _set-repo-pub:
 

docs/admin/system_admin/apache-config.rst

@@ -8,7 +8,7 @@ the information in the following sections.
 
 .. toctree::
 
-   apache-conf-example
-   apache-diffie-hellman
-   apache-subdirectory
-   apache-wsgi-coding
+   apache/apache-conf-example
+   apache/apache-diffie-hellman
+   apache/apache-subdirectory
+   apache/apache-wsgi-coding

docs/admin/system_admin/nginx-config.rst

@@ -8,7 +8,7 @@ the information in the following sections.
 
 .. toctree::
 
-   nginx-config-example
-   nginx-diffie-hellman
-   nginx-proxy-conf
-   nginx-url-prefix
+   nginx/nginx-config-example
+   nginx/nginx-diffie-hellman
+   nginx/nginx-proxy-conf
+   nginx/nginx-url-prefix

docs/admin/system_admin/tuning-rhodecode.rst

@@ -0,0 +1,21 @@
+.. _rhodecode-tuning-ref:
+
+Tuning |RCE|
+============
+
+To customize your |RCE| |version| installation for maximum performance you
+may find some of the following methods useful.
+
+.. toctree::
+
+   tuning/tuning-gunicorn
+   tuning/tuning-vcs-memory-cache
+   tuning/tuning-user-sessions-performance
+   tuning/tuning-increase-db-performance
+   tuning/tuning-scale-horizontally-cluster
+   tuning/tuning-mount-cache-memory
+   tuning/tuning-change-encoding
+   tuning/tuning-change-large-file-dir
+   tuning/tuning-change-lfs-dir
+   tuning/tuning-hg-auth-loop
+

docs/admin/system_admin/tuning/tuning-gunicorn.rst

@@ -42,7 +42,7 @@ To do this, use the following steps:
     ## restarted, could prevent memory leaks
     max_requests = 1000
     max_requests_jitter = 30
-    ## amount of time a worker can spend with handling a request before it
+    ## amount of time a worker can spend with handling a request tuning-change-lfs-dir.before it
     ## gets killed and restarted. Set to 6hrs
     timeout = 21600
 

docs/admin/tuning-rhodecode.rst

@@ -1,21 +0,0 @@
-.. _rhodecode-tuning-ref:
-
-Tuning |RCE|
-============
-
-To customize your |RCE| |version| installation for maximum performance you
-may find some of the following methods useful.
-
-.. toctree::
-
-   tuning-gunicorn
-   tuning-vcs-memory-cache
-   tuning-user-sessions-performance
-   tuning-increase-db-performance
-   tuning-scale-horizontally-cluster
-   tuning-mount-cache-memory
-   tuning-change-encoding
-   tuning-change-large-file-dir
-   tuning-change-lfs-dir
-   tuning-hg-auth-loop
-

docs/api/api.rst

@@ -204,6 +204,7 @@ are not required in args.
    methods/pull-request-methods
    methods/repo-methods
    methods/repo-group-methods
+   methods/search-methods
    methods/server-methods
    methods/user-methods
    methods/user-group-methods

docs/api/methods/repo-methods.rst

@@ -462,6 +462,7 @@ get_repo_file
    :param cache: Use internal caches for fetching files. If disabled fetching
        files is slower but more memory efficient
    :type cache: Optional(bool)
+
    Example output:
 
    .. code-block:: bash
@@ -499,53 +500,51 @@ get_repo_nodes
 .. py:function:: get_repo_nodes(apiuser, repoid, revision, root_path, ret_type=<Optional:'all'>, details=<Optional:'basic'>, max_file_bytes=<Optional:None>)
 
    Returns a list of nodes and children in a flat list for a given
-       path at given revision.
+   path at given revision.
 
-       It's possible to specify ret_type to show only `files` or `dirs`.
+   It's possible to specify ret_type to show only `files` or `dirs`.
 
-       This command can only be run using an |authtoken| with admin rights,
-       or users with at least read rights to |repos|.
+   This command can only be run using an |authtoken| with admin rights,
+   or users with at least read rights to |repos|.
 
-       :param apiuser: This is filled automatically from the |authtoken|.
-       :type apiuser: AuthUser
-       :param repoid: The repository name or repository ID.
-       :type repoid: str or int
-       :param revision: The revision for which listing should be done.
-       :type revision: str
-       :param root_path: The path from which to start displaying.
-       :type root_path: str
-       :param ret_type: Set the return type. Valid options are
-           ``all`` (default), ``files`` and ``dirs``.
-       :type ret_type: Optional(str)
-       :param details: Returns extended information about nodes, such as
-           md5, binary, and or content.
-           The valid options are ``basic`` and ``full``.
-       :type details: Optional(str)
-       :param max_file_bytes: Only return file content under this file size bytes
-       :type details: Optional(int)
+   :param apiuser: This is filled automatically from the |authtoken|.
+   :type apiuser: AuthUser
+   :param repoid: The repository name or repository ID.
+   :type repoid: str or int
+   :param revision: The revision for which listing should be done.
+   :type revision: str
+   :param root_path: The path from which to start displaying.
+   :type root_path: str
+   :param ret_type: Set the return type. Valid options are
+       ``all`` (default), ``files`` and ``dirs``.
+   :type ret_type: Optional(str)
+   :param details: Returns extended information about nodes, such as
+       md5, binary, and or content.
+       The valid options are ``basic`` and ``full``.
+   :type details: Optional(str)
+   :param max_file_bytes: Only return file content under this file size bytes
+   :type details: Optional(int)
 
-       Example output:
+   Example output:
 
-       .. code-block:: bash
+   .. code-block:: bash
 
-           id : <id_given_in_input>
-           result: [
-                       {
-                         "binary": false,
-                         "content": "File line
-   Line2
-   ",
-                         "extension": "md",
-                         "lines": 2,
-                         "md5": "059fa5d29b19c0657e384749480f6422",
-                         "mimetype": "text/x-minidsrc",
-                         "name": "file.md",
-                         "size": 580,
-                         "type": "file"
-                       },
-                     ...
-                   ]
-           error:  null
+       id : <id_given_in_input>
+       result: [
+                   {
+                     "binary": false,
+                     "content": "File line",
+                     "extension": "md",
+                     "lines": 2,
+                     "md5": "059fa5d29b19c0657e384749480f6422",
+                     "mimetype": "text/x-minidsrc",
+                     "name": "file.md",
+                     "size": 580,
+                     "type": "file"
+                   },
+                 ...
+               ]
+       error:  null
 
 
 get_repo_refs 

docs/api/methods/search-methods.rst

@@ -0,0 +1,35 @@
+.. _search-methods-ref:
+
+search methods
+==============
+
+search 
+------
+
+.. py:function:: search(apiuser, search_query, search_type, page_limit=<Optional:10>, page=<Optional:1>, search_sort=<Optional:'newfirst'>, repo_name=<Optional:None>, repo_group_name=<Optional:None>)
+
+   Fetch Full Text Search results using API.
+
+   :param apiuser: This is filled automatically from the |authtoken|.
+   :type apiuser: AuthUser
+   :param search_query: Search query.
+   :type search_query: str
+   :param search_type: Search type. The following are valid options:
+       * commit
+       * content
+       * path
+   :type search_type: str
+   :param page_limit: Page item limit, from 1 to 500. Default 10 items.
+   :type page_limit: Optional(int)
+   :param page: Page number. Default first page.
+   :type page: Optional(int)
+   :param search_sort: Search sort order. Default newfirst. The following are valid options:
+       * newfirst
+       * oldfirst
+   :type search_sort: Optional(str)
+   :param repo_name: Filter by one repo. Default is all.
+   :type repo_name: Optional(str)
+   :param repo_group_name: Filter by one repo group. Default is all.
+   :type repo_group_name: Optional(str)
+
+

docs/index.rst

@@ -46,7 +46,7 @@ and commit files and |repos| while managing their security permissions.
    nix/default-env
    admin/system-admin
    admin/user-admin
-   admin/setting-repo-perms
+   admin/repo-admin
    admin/security-tips
    auth/auth
    issue-trackers/issue-trackers

rhodecode/api/views/repo_api.py

@@ -444,7 +444,7 @@ def get_repo_nodes(request, apiuser, repoid, revision, root_path,
         result: [
                     {
                       "binary": false,
-                      "content": "File line\nLine2\n",
+                      "content": "File line",
                       "extension": "md",
                       "lines": 2,
                       "md5": "059fa5d29b19c0657e384749480f6422",
@@ -529,6 +529,7 @@ def get_repo_file(request, apiuser, repoid, commit_id, file_path,
     :param cache: Use internal caches for fetching files. If disabled fetching
         files is slower but more memory efficient
     :type cache: Optional(bool)
+
     Example output:
 
     .. code-block:: bash