Skip to content

Commit

Permalink
fix minor doc and env issues (#1061, #1064, #1066)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikkonie committed Jan 5, 2023
1 parent 5fc4f93 commit b846acb
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 12 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Fixed
- Use ``apt-get`` instead of ``apt`` in CI (#1030)
- Incorrect branch in ``README.rst`` Coveralls link (#1031)
- Postgres role errors in GitHub Actions CI (#1033)
- ``install_postgres.sh`` breaking with unsupported Ubuntu versions (#1061)

Removed
-------
Expand Down
10 changes: 3 additions & 7 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,17 +86,13 @@ Ready to contribute code to SODAR Core? Here are the steps to get started.
$ git checkout -b 123-branch-name dev

5. When you're done making changes, make sure to apply proper formatting using
Black and the settings specified in the accompanying ``black.sh`` script.
Next, check that your changes pass flake8. Finally, run the tests. It is
recommended to use the ``Makefile`` to ensure the correct Django
configuration for testing is selected. ::
Black. Next, check linting with flake8. Finally, run the tests.::

$ ./black.sh
$ make black
$ flake8 .
$ make test

6. Once the tests and flake8 pass, commit your changes and push your branch to
GitHub. ::
6. Once flake8 and tests, commit your changes and push your branch to GitHub. ::

$ git add .
$ git commit -m "add/update/fix issue-description-here (#issue-id)"
Expand Down
10 changes: 9 additions & 1 deletion docs/source/dev_core_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,20 @@ Initialize the database (this will also synchronize django-plugins):
$ ./manage.py migrate
Create a Django superuser for the example_site:
Create a Django superuser for the example site:

.. code-block:: console
$ ./manage.py createsuperuser --skip-checks --username admin
Run the ``geticons`` and ``collectstatic`` commands to download and enable
Iconify icons:

.. code-block:: console
$ ./manage.py geticons
$ ./manage.py collectstatic
You are now able to run the server:

.. code-block:: console
Expand Down
3 changes: 0 additions & 3 deletions env.example
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,3 @@ PROJECTROLES_DISABLE_CATEGORIES=0

# API settings
SODAR_API_DEFAULT_HOST=https://your.deployment.host

# Taskflow settings
# TASKFLOW_SODAR_SECRET=abc123
2 changes: 1 addition & 1 deletion utility/install_postgres.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
echo "***********************************************"
echo "Installing PostgreSQL v11"
echo "***********************************************"
add-apt-repository -y "deb http://apt.postgresql.org/pub/repos/apt/ focal-pgdg main"
add-apt-repository -y "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release -cs)-pgdg main"
wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
apt-get -y update
apt-get -y install postgresql-11

0 comments on commit b846acb

Please sign in to comment.