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

Developer Workflow #154

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

Conversation

Ron-Zarbyte
Copy link

@Ron-Zarbyte Ron-Zarbyte commented Oct 4, 2023

Refer to: FOSSBilling/FOSSBilling#1583

This improves workflow documentation from the perspective of a developer new to FOSSBilling. Two options are documented:

  1. Remote Installation (for cpanel, plesk, apache, nginx, etc)
  2. Local installation with Docker (using locally built images versus the fossbilling docker repo)

I feel these updates accomplish the goal of clarifying new developer workflow, but I am open to making more improvements where needed.

The documentation does refer to a specific install folder handling with enabling debug mode. That behavior does not exist yet, and is something I submit a pull request for. Refer to: FOSSBilling/FOSSBilling#1692

Copy link
Member

@BelleNottelling BelleNottelling left a comment

Choose a reason for hiding this comment

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

Looks like a pretty decent start. I pushed to your branch to add formatting to the shell codeblocks and to include info on PHPStan.

Docker info looks to be complete and I'm happy with that and I'm indifferent about the remote installation page.

In the same subject of all of this, we also have a (very basic) Building FOSSBilling page which should probably be improved and then moved into the developer workflow.

It would also be nice to get those steps updated to include info on the new translation releases and how to set those up, but that's really an optional step & only matters if someone wants a dev instance that has all of the correct translations with their completion % available inside of FOSSBilling

@Ron-Zarbyte
Copy link
Author

Agreed on those points. I'll loop back to this after the installer and get those additions in.

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.

3 participants