salesagility / SuiteDocs

SuiteCRM - Open source CRM for the world
https://docs.suitecrm.com/
Other
60 stars 285 forks source link

Update _index.en.adoc #573

Closed sweettbug3 closed 4 months ago

sweettbug3 commented 2 years ago

When building in dev mode it is much more convenient to supply the --watch flag sot that these commands do not require being re-run manually

samus-aran commented 2 years ago

Hey @sweettbug3 Thanks for the contribution!

Spoke to the core team and they offer a suggestion. Usually the --watch is better most of the time but you shouldn't need to use --watch if you are developing extensions only if there are changes to core (which we obviously don't recommend).

How about:

* Run `yarn run build-dev:common`
* Run `yarn run build-dev:core --watch`
* Run `yarn run build-dev:shell --watch`
sweettbug3 commented 2 years ago

I agree, that usually you would not expect anyone to be changing common or maybe even core. I will make that change.

Currently, there is no documentation about how to change anything or extend anything in core. Extensions seem to be useful for adding a new component, but not for changing any existing components. If extensions are meant to extend core, it is not clear how to wire them up to replace existing components/views. For example: the login page. If there is even a rough guide to customizing a core component, or customizing a module view, that would be incredibly helpful. I have looked at the examples provided and I haven’t been able to piece together how suitecrm8 is intended to be customized, without modifying core.

-Teresa

On Apr 14, 2022, at 3:38 AM, Ashley Nicolson @.***> wrote:

Hey @sweettbug3 https://github.com/sweettbug3 Thanks for the contribution!

Spoke to the core team and they offer a suggestion. Usually the --watch is better most of the time but you shouldn't need to use --watch if you are developing extensions only if there are changes to core (which we obviously don't recommend).

How about:

  • Run yarn run build-dev:common`

Run yarn run build-dev:core --watch Run `yarn run build-dev:shell --watch`` — Reply to this email directly, view it on GitHub https://github.com/salesagility/SuiteDocs/pull/573#issuecomment-1098937575, or unsubscribe https://github.com/notifications/unsubscribe-auth/ARSL2DW74DGY7L437WUJB5TVE7RQ7ANCNFSM5TIN4X4A. You are receiving this because you were mentioned.

jack7anderson7 commented 1 year ago

Hi @sweettbug3,

Thank you for the PR could you please update the PR to

* Run `yarn run build-dev:common`
* Run `yarn run build-dev:core --watch`
* Run `yarn run build-dev:shell --watch`

Following your conversation with @samus-aran.

Thanks, Jack

serhiisamko091184 commented 4 months ago

Hello @sweettbug3,

thanks for your contribution,

the current section, in which you were aiming to apply changes, has been rewritten, particularly the content of the index.en.adoc file has been changed.

I'm closing this PR, but if you'd like to continue working on this, feel free to reopen it.

Many thanks for your time and efforts!

Regards, Serhii