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

Provide help for title and description #51

Open
paltman opened this issue May 25, 2015 · 12 comments
Open

Provide help for title and description #51

paltman opened this issue May 25, 2015 · 12 comments

Comments

@paltman
Copy link
Member

paltman commented May 25, 2015

It's ideal to have titles no longer than 60 characters and meta descriptions no longer than 150 characters.

We should at least provide that help text in the admin, but ideally we should provide a character counter that decrements as you type.

@ossanna16
Copy link
Contributor

Would this be a good "difficulty: easy" issue for someone fairly new to programming or a "difficulty: medium" issue for someone who has a little more knowledge? This could be a good issue for someone looking to start contributing to Pinax 😊

@kkampardi
Copy link

Hey! i could work on this as my first contribution attempt to Pinax :)

@jtauber
Copy link
Member

jtauber commented Oct 29, 2016

@kkampardi definitely! let us know if you need any help

@kkampardi
Copy link

Sure @jtauber! I will start by reading the docs and installing the development environment. After that, I will definitely come back with lots of questions

@kkampardi
Copy link

kkampardi commented Oct 31, 2016

Hello again @jtauber!

  • I suppose this is an admin UI issue, so I won't make any changes in the Model, right?
  • I have no prior experience customizing the admin templates. I'll read the docs, however, any guidance in this direction will be helpful

@Plonq
Copy link

Plonq commented Dec 11, 2016

Hi! I'm new to contributing, and since it's been a little while since the last activity, I'd like to start with this issue (there aren't many to choose from).

The help text is easy, but as for the character counter I found this widget. But I am not sure the best way to integrate it. Copy the code? Import it as a separate app? Thinking about it, this feature would be handy on many admin pages ... maybe I'm getting ahead of myself.

Guidance?

@zeeshanabid94
Copy link

zeeshanabid94 commented Mar 30, 2018

I have installed the development environment and am able to access the admin panel. So the title field that is supposed to be 60 characters, this is the title of the Posts object. Right?

And where is the meta data field that has to be 160 characters?

I am assuming that this feature can be added in HTML and javascript without making any changes to the actual backend code. Am I assuming correct?

I can get this done as soon as I know which field we are talking about.

@KatherineMichel
Copy link
Member

Thank you for your help @zeeshanabid94! It looks like @paltman is talking about the title and description fields of the Post model, if I am understanding him correctly... ? If a description exists, it's returned through a function called meta_description.

@zeeshanabid94
Copy link

@KatherineMichel How do I test my code? It seems like the git repository is a build installed using pip. Should I set up a test django app, edit the code, build and install it and test it out?

Since this involves changing the front end html file, is there a way for me to render and see the changes?

I am sorry if this seems to be a naive question, it is my first time contributing to open source.

@grahamu
Copy link
Contributor

grahamu commented Apr 25, 2018

@zeeshanabid94 thanks for your desire to add tests for this issue. Regarding testing pinax-blog code, after adding appropriate tests to your local copy of the pinax-blog repo you then invoke tox. This runs all tests against all the Django/Python configurations.

If you are looking for guidance about how to write tests for your code, I'll need a bit more information about what you've added and what is expected. This is easiest if you push your changes and create a PR against pinax-blog "master" branch. Then we can take a look at what you are trying to test and provide guidance. Thanks!

@djl218
Copy link

djl218 commented Jan 24, 2020

Just wanted to check in. Is there anything else that needs to be done? New guy here, looking for some work.

@KatherineMichel
Copy link
Member

@djl218 We have a lot of work that needs to be done, but it's spread across many projects and some issues are complex. We are working on a new release now to drop Python 2.7, add Django 3.0 and do a few other things. I've documented the process. This is pretty accurate, but I need to make a few updates based on a recent PR for Django User Accounts that got the ball rolling. DUA is a dependency in a number of other Pinax apps. We also need assistance with docs. We can definitely use help if you are interested!
https://github.com/pinax/pinax/wiki/Pinax-20.xx-Proposed-Process
pinax/django-user-accounts#322

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

9 participants