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 doc for development environment setup #178

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jobselko
Copy link
Contributor

@jobselko jobselko commented Mar 10, 2025

This PR updates the quickstart documentation to make the development environment setup clearer and replaces the relevant section in README with a link to this file.

It also fixes the misspelled variable _pdbreset_help in the install_phelpers.sh file, which caused that an empty string was used instead of the variable's content.

Copy link
Member

@pedro-psb pedro-psb Mar 10, 2025

Choose a reason for hiding this comment

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

Cool, it's useful to make a clear distinction on required vs optional.

Since you are editing this, I think its worth mentioning p commands (see oci_env phelp).

When Gerrod introduced them to oci_env some months ago I found them to be really handy on day-to-day debugging to reset state (workers or db) without restarting the container.

Its just an idea, if you don't feel like doing it here I can add that later (just though it was worth mentioning).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you, any suggestions are always welcome! I added a note regarding "p commands". Please check if it is accurate.

Copy link
Member

Choose a reason for hiding this comment

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

That's a nice place and size to put it. Thanks!

AFAIK, these commands handle s6 services, which are multiple processes within the (single) dev container.

I guess it's more accurate to say something like:

- It contains "p commands" to ease managing pulp component services, such as workers (api, content and tasking) and postgres DB.

@jobselko jobselko force-pushed the update_quickstart branch from 6ba40dd to d0feb15 Compare March 11, 2025 18:53
@jobselko jobselko self-assigned this Mar 11, 2025
@jobselko jobselko force-pushed the update_quickstart branch from d0feb15 to e9ddb1e Compare March 11, 2025 20:10
@jobselko jobselko marked this pull request as ready for review March 11, 2025 20:15
@jobselko jobselko requested a review from gerrod3 March 14, 2025 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants