#59 Improve README (and fix typos)

Open
MathieuMD wants to merge 11 commits from Intarnet/pr1 into FFDN/master

[PR initially tried at #57]

[PR initially tried at #57]
jocelyn commented 6 years ago
Owner

Hello here, Thanks, realy good to have you eyes on that doc.

I do have some feedback/suggestions before integrating your changes.

  • Better if the venv folder is outside the git directory, so, directly in the same parent folder as the git cloned folder (that require putting the cd command latter in the doc and checking that this everything remain consisteat).

  • SITE_URL is a mandatory setting (so it should remain in that section)

  • Removing SITE_URL from settings/base.py could be a good idea, but only if we set it inside settings/dev.py (to http://localhost:8000). IMHO, the goal should be that dev settings work « out of the box ».

PS: well spotted for the broken div tag. Strange we did not see it before :x

Hello here, Thanks, realy good to have you eyes on that doc. I do have some feedback/suggestions before integrating your changes. - Better if the *venv* folder is outside the git directory, so, directly in the same parent folder as the git cloned folder (that require putting the cd command latter in the doc and checking that this everything remain consisteat). - `SITE_URL` is a mandatory setting (so it should remain in that section) - Removing `SITE_URL` from *settings/base.py* could be a good idea, but only if we set it inside *settings/dev.py* (to `http://localhost:8000`). IMHO, the goal should be that dev settings work « out of the box ». PS: well spotted for the broken div tag. Strange we did not see it before :x
jocelyn commented 6 years ago
Owner

@MathieuMD bump ? Tell me if you need help :-)

@MathieuMD bump ? Tell me if you need help :-)
MathieuMD commented 6 years ago
Poster

Hi Jocelyn. Sorry for the delay, quite a rush from everywhere lately...

I pushed a commit to move out venv and db.sqlite3 from git repo, and updated README.md.

However, when I try an installation for prod following this doc, I get 404 errors for all assets. But no problem for dev environment. I don't know where/what looking for. Can you reproduce the problem from a simple install you too?

Hi Jocelyn. Sorry for the delay, quite a rush from everywhere lately... I pushed a commit to move out `venv` and `db.sqlite3` from git repo, and updated README.md. However, when I try an installation for prod following this doc, I get 404 errors for all assets. But no problem for dev environment. I don't know where/what looking for. Can you reproduce the problem from a simple install you too?
jocelyn commented 6 years ago
Owner

Time passes by but PR survive :-).

So, thanks for your edits ; more feedback :

  • IMHO git checkout stuff is out of the scope of this doc : this is not a git manual
  • Finally, venv in parent dir (which was my suggestion :x) seems quite uncommon and complicates the whole process (paths, cd...). My current take : that may be a good idea for production setup, but not for development setup. So maybe better keep on « everything in git-ed folder and using .gitignore wisely »). Sorry for flipping.

  • The edits in « Run production server » break the nesting of code snippets into the list items and make the numbered list do 1. 2. 3. 4.

Let me know if you are still into that and willing to make the edits ; if so, thanks a lot :). If no, no prob, I will take over this edits, and thanks anyway !

Time passes by but PR survive :-). So, thanks for your edits ; more feedback : - IMHO `git checkout` stuff is out of the scope of this doc : this is not a git manual - Finally, *venv in parent dir* (which was my suggestion :x) seems quite uncommon and complicates the whole process (paths, cd...). My current take : that may be a good idea for production setup, but not for development setup. So maybe better keep on « everything in git-ed folder and using *.gitignore* wisely »). Sorry for flipping. - The edits in « Run production server » break the nesting of code snippets into the list items and make the numbered list do 1. 2. 3. 4. Let me know if you are still into that and willing to make the edits ; if so, thanks a lot :). If no, no prob, I will take over this edits, and thanks anyway !
MathieuMD commented 6 years ago
Poster

Indeed, it'd helpful if you could handle these edits! Thanks.

Indeed, it'd helpful if you could handle these edits! Thanks.
This pull request can't be merged automatically because there are conflicts.
Please merge manually in order to resolve the conflicts.
Sign in to join this conversation.
No Milestone
No assignee
2 Participants
Loading...
Cancel
Save
There is no content yet.