Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates in the README #2750

Merged
merged 7 commits into from
Aug 28, 2024
+38 −23
Merged

Updates in the README #2750

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
51448a0
Updates in the README
rjlanari Aug 21, 2024
9de8e48
New updates on README.md
rjlanari Aug 21, 2024
4159141
Latest changes in README
rjlanari Aug 27, 2024
1788d1c
Corrected typos in README and corrected cahngelog 7978.md to comply w…
rjlanari Aug 27, 2024
9c94cd9
Updates in the README and added link to technical documentation
rjlanari Aug 27, 2024
faaa7d2
README latest adjustments
rjlanari Aug 28, 2024
ac0e741
Updates README with better layout
rjlanari Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,18 @@ adhocracy+ is designed to make online participation easy and accessible to every

### Requirements

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we are revisiting the README, we can also add the tech docs.
On line 3 please add a link to our technical documentation.
E.g The project's technical documentation is in progress. You are welcome to leave your feedback on the documentation by creating a github issue.

* nodejs (+ npm)
* nodejs (+ npm)
* python 3.x (+ venv + pip)
* libpq (only if postgres should be used)
* sqlite3 [with JSON1 enabled](https://code.djangoproject.com/wiki/JSON1Extension)
* redis (in production, not needed for development)
* pillow-heif (required for macos M1 ...etc)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By ...etc I meant what you had there already ;)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rjlanari see my latest comment above.


### Installation

git clone https://github.com/liqd/adhocracy-plus.git
cd adhocracy-plus
make install
make install
make fixtures

### Start virtual environment
Expand Down Expand Up @@ -57,7 +58,10 @@ Go to http://localhost:8004/ and login with [email protected] | password

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line 70 needs to go in the section Start a local server under line 40.

For a celery worker to pick up tasks you need to make sure that:
- the redis server is running
run: redis-cli ping (it should return: PONG)
- the celery config parameter "always eager" is disabled (add `CELERY_TASK_ALWAYS_EAGER = False` to your `local.py`)
(Celery's always_eager is disabled to ensure tests run tasks when calling code instead of schedulingmac them via the Redis broker.)
To find local.py run: find . -name "local.py"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is no local.py when installing from the repo. We need to create it under adhocracy_plus/config/settings.
Nice to add that the local.py can also have other customised settings such as a postgresql database setting for development.

Also would be good to point here that the celery always eager is disabled so that tests can run the celery tasks from the code that is calling them rather than scheduling them with the redis broker.

And we could end this celery section by pointing to our extensive celery documentation.
on line 79 below.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make the changes as you point out!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks. once you make and push your changes, click the refresh button next to my reviewer name

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is a typo now schedulingmac

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the line To find local.py run: find . -name "local.py".
Instead add: local.py sould be under adhocracy_plus/config/settings, create one if it doesn't exist. This file saves settings for local development.


To start a celery worker node in the foreground, call:
```
Expand All @@ -73,6 +77,7 @@ To send a dummy task to the queue and report the result, call:
```
make celery-worker-dummy-task
```
Check out our extensive [celery documentation](https://github.com/liqd/adhocracy-plus/compare/docs/celery.md?expand=1)

## Installation on a production system

Expand Down
3 changes: 3 additions & 0 deletions changelog/7978.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### Changes in the README

I added to the readme some notes and new comands that helped me with the installation of the a+ repository locally.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't use personal pronouns in the changelog, it needs to be neutral writing.
we are following this format : https://keepachangelog.com/en/1.1.0/
Titles can be:

Added for new features.
Changed for changes in existing functionality.
Deprecated for soon-to-be removed features.
Removed for now removed features.
Fixed for any bug fixes.
Security in case of vulnerabilities.

So the changelog would be more like the following:

### Changed 

-  Update README with some notes and new comands for the installation of the a+ repository locally.