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 docs #490

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update docs #490

wants to merge 1 commit into from

Conversation

JakubFrejlach
Copy link
Contributor

This PR:

  • updates the docs to address findings from @C-Valen during his local OSIDB instance setup
  • updates the docs to mention the existence of reference .env files in osidb-ops repository

Partially related to OSIDB-2420

@JakubFrejlach JakubFrejlach requested a review from a team April 11, 2024 12:40
@JakubFrejlach JakubFrejlach self-assigned this Apr 11, 2024
@JakubFrejlach JakubFrejlach added documentation Improvements or additions to documentation technical For PRs that introduce changes not worthy of a CHANGELOG entry labels Apr 11, 2024
Comment on lines +9 to +12
The following dependencies are required for development and deployment:
* make
* podman (docker)
* podman-compose (docker-compose)
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a copypaste from this section. I'd either remove it from there and reference this section instead, or don't add this as it doesn't provide any new info.

Copy link
Contributor

@osoukup osoukup left a comment

Choose a reason for hiding this comment

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

I agree with what @dmonzonis mentioned. Otherwise LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation technical For PRs that introduce changes not worthy of a CHANGELOG entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants