From 59df737ce3e65e34c5ea8f2f7d5cf969338c0c85 Mon Sep 17 00:00:00 2001 From: William Di Luigi Date: Tue, 24 Dec 2024 00:01:48 +0100 Subject: [PATCH] Remove non-installed instructions from docs With the virtualenv as recommended install method this isn't really necessary anymore, so we'd rather avoid supporting this. --- .github/ISSUE_TEMPLATE/Bug_report.md | 6 ++--- .github/SUPPORT.md | 3 +-- README.md | 3 +-- docs/Installation.rst | 37 ---------------------------- 4 files changed, 4 insertions(+), 45 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 969472767..9f0fc42c6 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -28,13 +28,11 @@ If instead you have found a possible bug, please go ahead filing the issue using ### Logs -[Please attach relevant logs of the component(s) that caused the problem; you can find them in /var/local/log/cms/ (if CMS was running -installed) or in ./log (if it was running from the local copy).] +[Please attach relevant logs of the component(s) that caused the problem; you can find them in /var/local/log/cms/.] ### System Information **CMS version:** [master, or a specific version] -**Was CMS installed:** [yes or no] -**Using a virtualenv:** [yes or no] +**How was CMS installed:** [virtualenv, docker, ...?] **Postgres version:** [if relevant] **Distribution and version:** [if relevant] diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 6d1fb919a..cea51ed69 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -12,8 +12,7 @@ or write on the **support mailing list** To help with the troubleshooting, you can upload on some online pastebin the relevant **log files**, that you can find in -/var/local/log/cms/ (if CMS was running installed) or in ./log (if it -was running from the local copy). +`/var/local/log/cms/`. If you encountered a bug, please file an [issue](https://github.com/cms-dev/cms/issues) on **GitHub** following diff --git a/README.md b/README.md index 16e1cfb4b..0bb74daae 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,7 @@ required (you can see the archives on [Google Groups](https://groups.google.com/forum/#!forum/contestms-support)). To help with the troubleshooting, you can upload on some online pastebin the -relevant **log files**, that you can find in `/var/local/log/cms/` (if CMS was -running installed) or in ./log (if it was running from the local copy). +relevant **log files**, that you can find in `/var/local/log/cms/`. If you encountered a bug, please file an [issue](https://github.com/cms-dev/cms/issues) on **GitHub** following the diff --git a/docs/Installation.rst b/docs/Installation.rst index 8c6aaecf6..f57c07d54 100644 --- a/docs/Installation.rst +++ b/docs/Installation.rst @@ -228,43 +228,6 @@ Apart from validity, there are many possible tweaks to reduce the variability in We suggest following isolate's `guidelines `_ for reproducible results. -.. _installation_running-cms-non-installed: - -Running CMS non-installed -========================= - -To run CMS without installing it in the system, you need first to build the prerequisites: - -.. sourcecode:: bash - - python3 prerequisites.py build - -There are still a few steps to complete manually in this case. First, add CMS and isolate to the path and create the configuration files: - -.. sourcecode:: bash - - export PATH=$PATH:./isolate/ - export PYTHONPATH=./ - cp config/cms.conf.sample config/cms.conf - cp config/cms.ranking.conf.sample config/cms.ranking.conf - -Second, perform these tasks (that require root permissions): - -* create the ``cmsuser`` user and a group with the same name; - -* add your user to the ``cmsuser`` group; - -* set isolate to be owned by root:cmsuser, and set its suid bit. - -For example: - -.. sourcecode:: bash - - sudo useradd cmsuser - sudo usermod -a -G cmsuser - sudo chown root:cmsuser ./isolate/isolate - sudo chmod u+s ./isolate/isolate - Updating CMS ============