docs: updated documentation structure

This commit is contained in:
Marcin Kuzminski 2019-05-21 16:33:01 +02:00
parent 434efcd94f
commit eddc784e19
47 changed files with 158 additions and 98 deletions

View file

@ -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

View file

@ -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()

View file

@ -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

View file

@ -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

View file

@ -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:

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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