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 Developers Docs #22

Merged
merged 2 commits into from
Dec 24, 2024
Merged

Update Developers Docs #22

merged 2 commits into from
Dec 24, 2024

Conversation

arthurpar06
Copy link
Contributor

I changed many things, so it would be great if someone could review it. I was careful, but I probably left some English mistakes as well.

@FatihKoz
Copy link
Contributor

If all these are designed for Laravel 11 then we should wait for it, if not we should provide other alternatives for development environments and provide links for what we have at the moment.

One may not wish to have docker, does not want to use Laravel Sail etc. In theory, these documents are here to help people while creating modules and/or supporting their VA's.

Of course it will not be possible to cover and document all possible environment alternatives but there should be at least some references here that there are alternatives and what is written here is not a "must" for developing stuff for phpvms v7.

Like you can simply have xammp, wammp, laragon etc on your Windows and easily develop stuff without following any of these steps/topics in this guide.

  • A running local http server, mysql/maria server
  • Matching php version, composer and maybe node for packages
  • Access to matching Laravel Docs

Just my general thoughts.

@arthurpar06
Copy link
Contributor Author

arthurpar06 commented Jul 27, 2024

Good catch with the links, I didn't notice that but i'll change them in the afternoon :)

Also, I completely agree that Docker isn't required. There is indeed a "Without Docker" section in what I'm proposing, but it might be a bit short, we could maybe add some more information.

This is what's currently in the PR. Let me know what you'd like to add.

EDIT: After rereading, it also needs to be clarified that it's really the dev-install command that requires sqlite, not composer or anything else.

image

@FatihKoz
Copy link
Contributor

Yeah I mean it starts with a full config and wording about it :) The way how Nabeel works, it is nice for people with knowledge but I think this page should be more generic.

It should start with a basic explanation about it is possible to have a local environment for tests and development, and then it should go on with basics and details like

Introduction
Basic Requirements
Simple Setup (without docker can be placed maybe here)
Expanded Setup (with docker, more dev stuff etc)

If a normal guy, non-dev but with some needs, want to learn, he/she should not be blown up with tons of tech stuff in the first lines of a doc. An experienced dev can skip them and move forwards but normal people (with some basic knowledge) not :)

@FatihKoz
Copy link
Contributor

By the above I mean the complete section should be revised, not only this page 😉

Building assets, addons, awards all of them. Then we can have a nice documentation for development & enhancements.

@arthurpar06
Copy link
Contributor Author

Yeah, I agree. Writing clear documentation is really not easy... at least I find it difficult. But your idea is good - creating something clean that explains both the basics for those who need them and the technical details for those who want to do more advanced stuff is a nice idea.

@nabeelio nabeelio merged commit 2474cd4 into phpvms:master Dec 24, 2024
1 of 2 checks passed
@arthurpar06 arthurpar06 deleted the devDocs branch December 24, 2024 20:28
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