enonic / doc-xp

Enonic XP > 7.0 Reference Documentation
2 stars 3 forks source link

Document Development mode #148

Closed rymsha closed 3 years ago

rymsha commented 4 years ago

In a few places documentation mentions XP development mode. For instance https://developer.enonic.com/docs/enonic-cli/master#deploy

But Development mode is not explained:

thomasheartman commented 3 years ago

Does this concern the XP docs or the CLI docs? Both? #247 is similar to this, but only concerns the XP docs. It's also more about the difference between dev mode and continuous builds.

If this is about the XP docs, are the changes introduced in #248 sufficient?

Edit

I see now that this is is mentioned in enonic/xp#8117:

To sum up

  • it always (often unnecessarily) slows down page loading/rendering in dev mode
  • it modifies XP behavior between dev and prod mode
  • it does not always work
  • it requires a bit extra code testing and support
  • it has a robust alternative

As such, this probably needs some extra documentation. If what's listed above is all that's necessary, I'm happy to give it a go 🙋🏾

rymsha commented 3 years ago
thomasheartman commented 3 years ago

Got it! Thanks for the feedback and for clearing up how dev mode works! I'll go and make sure to correct it and add the warning about production use 👍🏾

alansemenov commented 3 years ago

Will be fixed in https://github.com/enonic/doc-xp/issues/247