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

would love to see some documentation enhancements. #18

Closed
ParvJain opened this issue Mar 7, 2015 · 16 comments
Closed

would love to see some documentation enhancements. #18

ParvJain opened this issue Mar 7, 2015 · 16 comments

Comments

@ParvJain
Copy link
Contributor

ParvJain commented Mar 7, 2015

i can't escape the fact that edge is one of it's kind right now and it is very helpful for any django developer out there, but it need a more better documentions you can add several code snippets and explain them or you can just show how the things actually works by using django api. these changes will be very helpful for a new guy to easily get used to edge code, without going through it.

Thanks.

@abadger1406
Copy link

Also, document how to run this with gunicorn - i.e you should edit wsg.py and have some comment about using the two different settings....

i"""
WSGI config for my_proj project.

It exposes the WSGI callable as a module-level variable named application.

For more information on this file, see
https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/
"""

import os
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "my_proj.settings.development")
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "my_proj.settings.production")

from django.core.wsgi import get_wsgi_application
application = get_wsgi_application()

@arocks
Copy link
Owner

arocks commented Mar 10, 2015

Excellent suggestion. I was thinking of breaking up the documentation into sections like installation or FAQ. Any ideas will be welcome.

@arocks
Copy link
Owner

arocks commented Mar 17, 2015

I have started work on improving and reorganizing the documentation here: https://github.com/arocks/edge/wiki

Please let me know which topics I should address or you would like to see.

@ParvJain
Copy link
Contributor Author

That's good! I am having troubles while adding some profile related fields so, I'd love to see some examples of extending user model and adding more fields in sign up form... it would be awesome, to see some refrences of python shell api examples of them.

@jcda
Copy link

jcda commented Mar 17, 2015

Excellent work Arun, from my side I'd love to see more input about authentication, I would be interested in a social network integration with something like django-social-auth .

@ParvJain
Copy link
Contributor Author

can someone help me with these:

  • what is the python shell api commands to fetch user's bio?
  • how to add bio field in signup form?

@arocks
Copy link
Owner

arocks commented Mar 18, 2015

Thank you all. These are great suggestions.

@ParvJain Unless I am mistaken, fetching the user's bio should be fairly straightforward:

$ python manage.py shell
In [1]: from django.contrib.auth import get_user_model

In [2]: User = get_user_model()

In [4]: User.objects.get(pk=1)
Out[4]: <User: Harry Potter <a@a.com>>

In [5]: User.objects.get(pk=1).profile.bio
Out[5]: 'My bio is just a one-liner'

@ParvJain
Copy link
Contributor Author

That was exactly what i was looking for. I was dumb enough to call profile seprately. anyways, thanks for helping with my potato grade problem. :)

@abadger1406
Copy link

Hi,

Using edge for a new project, and certainly want to feedback. What is best
way to do this...account on github...suggest changes to you..or like here
via email ?

Should you not use the cdn fir bootstrapped..i.e change base.html to have

...
...

<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/li bs/twitter-bootstrap/3.3.2/js/bootstrap.min.js"></script>

What does the bootstrapped admin give you .. it looks very unstyed/unclear
to me...but perhaps I'm missing something here.

Lastly I too am interested in the social login add on for this project...

Thanks Dave

On 18 March 2015 at 12:45, Arun Ravindran notifications@github.com wrote:

Thank you all. These are great suggestions.

@ParvJain https://github.com/ParvJain Unless I am mistaken, fetching
the user's bio should be fairly straightforward:

$ python manage.py shell
In [1]: from django.contrib.auth import get_user_model

In [2]: User = get_user_model()

In [4]: User.objects.get(pk=1)
Out[4]: <User: Harry Potter a@a.com>

In [5]: User.objects.get(pk=1).profile.bio
Out[5]: 'My bio is just a one-liner'


Reply to this email directly or view it on GitHub
#18 (comment).

David Herring

@arocks
Copy link
Owner

arocks commented Mar 21, 2015

Hi Dave,

You could raise separate issues in the Github issue tracker. I have found this to be the best way for suggestions, feature requests or even queries.

Edge uses a customized version of the Bootstrap template. From my experience, most project avoid using the default Bootstrap CSS since users find it too boring. I also prefer to have an offline copy in development. However, you are free to change the base.html to suit your project.

Bootstrapped admin is more mobile-friendly and readable (subjective opinion of course 😄 ) than the default. It shares the same CSS as the main site so it looks consistent to the rest of the site.

Social login is a good suggestion. I plan to address it in the documentation soon.

Thanks for trying edge and sharing your thoughts.

@abadger1406
Copy link

Hi Arun,

Hope all goes well.

When starting a new 'app' within django edge, what is the suggested
command. I.E do you just

cd src
django-admin.py start app bookings

Also, would be nice to have a little more understanding of way there are
two apps profiles and accounts. Maybe I'm missing the key understaning on
the layout.

BTW - do you have a skype number, mine is 'abadger1406'. If you do
consultancy work I might be able to fund a few days that would also help
push Django Edge further.

Thanks Dave

On 21 March 2015 at 15:15, Arun Ravindran notifications@github.com wrote:

Hi Dave,

You could raise separate issues in the Github issue tracker. I have found
this to be the best way for suggestions, feature requests or even queries.

Edge uses a customized version of the Bootstrap template. From my
experience, most project avoid using the default Bootstrap CSS since users
find it too boring. I also prefer to have an offline copy in development.
However, you are free to change the base.html to suit your project.

Bootstrapped admin is more mobile-friendly and readable (subjective
opinion of course [image: 😄] ) than the default. It shares the same
CSS as the main site so it looks consistent to the rest of the site.

Social login is a good suggestion. I plan to address it in the
documentation soon.

Thanks for trying edge and sharing your thoughts.


Reply to this email directly or view it on GitHub
#18 (comment).

David Herring

@ParvJain
Copy link
Contributor Author

@abadger1406

  1. Please go through existing django-edge documentation, it would be pretty slick to get the things started - https://github.com/arocks/edge/wiki#quick-start
  2. The layout used is bootstrap, you can easily learn about bootstrap from here. - http://getbootstrap.com/getting-started/

Hope this helps.

@arocks
Copy link
Owner

arocks commented Apr 27, 2015

Hi @abadger1406

You are mostly right about starting a new app. The command (as mentioned in Django docs/tutorial) would be:

cd src
python manage.py startapp bookings

Technically, I could provide a template for new apps as well. But I have not found a reason yet as the standard app template is minimal and yet has everything you need.

I have added a simple Architecture doc to the wiki to help understand what the respective apps are for. Any feedback on improving the doc would be welcome!

I'm arocks80 on Skype.

@abadger1406
Copy link

Thanks for the helpful responses...I'm learning fast here.

What sets the template loader to look in each app directory for templates
.. so that for example "bookings/index.html" is found ?

Thanks Dave

On 27 April 2015 at 09:52, Arun Ravindran notifications@github.com wrote:

Hi @abadger1406 https://github.com/abadger1406

You are mostly right about starting a new app. The command (as mentioned
in Django docs/tutorial) would be:

cd src
python manage.py startapp bookings

Technically, I could provide a template for new apps as well. But I have
not found a reason yet as the standard app template is minimal and yet has
everything you need.

I have added a simple Architecture
https://github.com/arocks/edge/wiki/Architecture doc to the wiki to
help understand what the respective apps are for. Any feedback on improving
the doc would be welcome!

I'm arocks80 on Skype.


Reply to this email directly or view it on GitHub
#18 (comment).

David Herring

@abadger1406
Copy link

Ok... appears that django it automatically looks in each app direrctory for
the a templates directory .. so ignore last question.

Thanks Dave

On 28 April 2015 at 07:08, David Herring dave@netfm.org wrote:

Thanks for the helpful responses...I'm learning fast here.

What sets the template loader to look in each app directory for templates
.. so that for example "bookings/index.html" is found ?

Thanks Dave

On 27 April 2015 at 09:52, Arun Ravindran notifications@github.com
wrote:

Hi @abadger1406 https://github.com/abadger1406

You are mostly right about starting a new app. The command (as mentioned
in Django docs/tutorial) would be:

cd src
python manage.py startapp bookings

Technically, I could provide a template for new apps as well. But I have
not found a reason yet as the standard app template is minimal and yet has
everything you need.

I have added a simple Architecture
https://github.com/arocks/edge/wiki/Architecture doc to the wiki to
help understand what the respective apps are for. Any feedback on improving
the doc would be welcome!

I'm arocks80 on Skype.


Reply to this email directly or view it on GitHub
#18 (comment).

David Herring

David Herring

@arocks
Copy link
Owner

arocks commented Jun 2, 2015

With the transition of the documentation to http://django-edge.readthedocs.org/en/latest/ from Github wiki and expanded content, I hope this issue can be finally closed 😄

@arocks arocks closed this as completed Jun 2, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants