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

Jump to bottom

Update Contributor Documentation #1171

Merged
merged 6 commits into from Mar 2, 2023
Merged

Update Contributor Documentation #1171

merged 6 commits into from Mar 2, 2023

Conversation

kingychiu
Copy link
Contributor

Issue #1161

  1. Suggest the developer to visit the project folder directly instead of the script folder because the documentation in the project folder is much better than those in the script folder.
  2. Slight modification to the backend documentation.

@github-actions
Copy link

github-actions bot commented Feb 5, 2023

❌ pre-commit failed.
Please run pre-commit run --all-files locally and commit the changes.
Find more information in the repository's CONTRIBUTING.md

@kingychiu kingychiu mentioned this pull request Feb 5, 2023
Closed
@andrewm4894 andrewm4894 enabled auto-merge (squash) February 5, 2023 13:56
andreaskoepf
andreaskoepf requested changes Feb 20, 2023
View reviewed changes
Copy link
Collaborator

@andreaskoepf andreaskoepf left a comment

Choose a reason for hiding this comment

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

docker compose command needs to be updated

backend/README.md Outdated
@@ -2,19 +2,26 @@

## Backend Development Setup

### Local Database

In root directory, run
`docker compose up backend-dev --build --attach-dependencies` to start a
Copy link
Collaborator

Choose a reason for hiding this comment

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

The new command is:
docker compose up --profile backend-dev up --build --attach-dependencies

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, updated.

auto-merge was automatically disabled February 21, 2023 11:18

Head branch was pushed to by a user without write access

@github-actions
Copy link

❌ pre-commit failed.
Please run pre-commit run --all-files locally and commit the changes.
Find more information in the repository's CONTRIBUTING.md

@github-actions
Copy link

❌ pre-commit failed.
Please run pre-commit run --all-files locally and commit the changes.
Find more information in the repository's CONTRIBUTING.md

@andreaskoepf andreaskoepf merged commit a7a1558 into LAION-AI:main Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrewm4894 andrewm4894 andrewm4894 approved these changes

@andreaskoepf andreaskoepf andreaskoepf approved these changes

@yk yk Awaiting requested review from yk yk is a code owner

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@kingychiu @andrewm4894 @andreaskoepf @AbdBarho