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.

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

Update documentation #760

Merged
merged 22 commits into from
Sep 6, 2021
Merged

Update documentation #760

merged 22 commits into from
Sep 6, 2021

Conversation

TAnas0
Copy link
Collaborator

@TAnas0 TAnas0 commented Aug 25, 2021

What is the Purpose?

Update our basic documentation in the repository.
The README is a bit overwhelming and too specific. It also tries to describe all possible scenarios for running Activity:

  • Using pipenv or virtualenv
  • Operating System specific extra information
  • Setup of databases and managing them

I'd rather have a friendlier README with a quick Getting Started section based on Docker and Docker Compose, and leave the rest to the user who is doing the setup, and knows their machine.

What was the approach?

Briefly describe the approach used to address the issue

Are there any concerns to addressed further before or after merging this PR?

None

Mentions?

@andrew @ninetteadhikari

Issue(s) affected?

Fix #758

@TAnas0 TAnas0 self-assigned this Aug 25, 2021
@TAnas0 TAnas0 added the WIP For PRs that are opened but still in progress label Aug 25, 2021
@codecov
Copy link

codecov bot commented Aug 25, 2021

Codecov Report

Merging #760 (5085932) into develop (baa15a0) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #760   +/-   ##
========================================
  Coverage    57.61%   57.61%           
========================================
  Files          143      143           
  Lines         9223     9223           
========================================
  Hits          5314     5314           
  Misses        3909     3909           

Copy link
Member

@andrewtpham andrewtpham left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for all this clean up work 💪 @TAnas0

@TAnas0 TAnas0 merged commit e153610 into develop Sep 6, 2021
@andrewtpham andrewtpham deleted the 758-update-docs branch September 7, 2021 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WIP For PRs that are opened but still in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation
3 participants