Update build instructions following move to Poetry #410
Conversation
Our current docs still describe our now-deprecated build method based on buildout. This commit includes a series of changes to describe our new build instructions based on Poetry: - modify missing build dependencies - use our new build.sh script - update new required source tree root (/opt/rockstor)
Harmonize use of GitHub vs Github. Emphasize some important notes by moving them to note blocks. Highlight paths by using `:code:` annotation. Minor typos or style changes.
There was a problem hiding this comment.
@FroggyFlox this is all a most welcome update. Thanks. And as always much appreciated.
I've popped in a few suggestions that I think would be nice-to-haves, see what you think.
Either way I think this is ready for PRODUCTION as the sooner we get this updated the better. I'll await your decisions on the suggestions and then I can publish there-after if you don't beat me to it.
| .. code-block:: text | ||
|
|
||
| buildvm:~ # cd /opt/rockstor | ||
| buildvm:~ # export DJANGO_SETTINGS_MODULE=settings | ||
| buildvm:~ # poetry run debug-mode ON | ||
|
|
||
| Everything that your code or any Rockstor service logs goes into the following files: |
There was a problem hiding this comment.
Thanks for this. I'm surprised we didn't already have this!
There was a problem hiding this comment.
Our buildout method actually automatically set DEBUG to True in settings.py. I forgot exactly how, but I remember seeing it. What do you think of adding an optional flag to build.sh to do that (leaving defaults as is, of course)?
There was a problem hiding this comment.
What do you think of adding an optional flag to
build.shto do that (leaving defaults as is, of course)?
That sound like the way to go, given we use the same script when building the package. Plus it will 'surface' this debug element for those that read no further than the build.sh itself. Which brings to mind the idea that we include a referenced to our developer docs within build.sh itself. So folks can easily find this doc section with only a casual look at build.sh.
There was a problem hiding this comment.
I do like the idea of adding a link to the docs in build.sh itself!
Co-authored-by: Philip Guyton <[email protected]>
Specify that Rockstor's jslibs are unzipped into the final directory by the build script. Co-authored-by: Philip Guyton <[email protected]>
Correct a remaining instance of the old `/opt/rockstor-dev` path to `/opt/rockstor`. Co-authored-by: Philip Guyton <[email protected]>
|
Thanks @phillxnet for your thorough review; I included all your suggestions. |
|
PR product PRODUCTION published. |
Fixes #405
@phillxnet, ready for review.
This pull request's proposal
Update our contribution instructions following our move to Poetry (04a7d21).
This PR also includes minor typos and style adjustments (a069da9) in an attempt at making the text more fluent and thus hopefully a bit easier to follow. I hope it actually achieves that.
@phillxnet, I've tried to separate the changes into two commits to ease review; commit 04a7d21 should include all changes related to the move to Poetry.
Checklist