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

Improve markdown support #402

Closed
rixx opened this issue Mar 31, 2018 · 2 comments
Closed

Improve markdown support #402

rixx opened this issue Mar 31, 2018 · 2 comments
Labels
size: big or difficult Will take a long time and/or a lot of skill stage: wip This issue is being worked on type: feature

Comments

@rixx
Copy link
Member

rixx commented Mar 31, 2018

This is an issue that is well-suited for external contributors – let me know if I can be of any help, either via this issue or via support@pretalx.com.

What this is about

pretalx allows many fields to be filled in with markdown support. It would be great to offer an editor with a preview tab. Bonus points for an editor like this one here at GitHub, supporting adding markup via buttons for people not familiar with markdown.

How to get started

First of all, leave a comment on this issue to make sure nobody else starts working on this issue at the same time!

Next, you need pretalx running locally on your machine. First, fork the repository to your own GitHub account. Then clone it locally (or set it as your remote if you already cloned it earlier)

Follow the developer setup guide, and then play around with pretalx a bit.
Have a look at the places impacting this issue. Look at the code responsible for the issues (searching for relevant words or files should help you find your way around). We have an explanation of our code structure and the actual data models.

How to do this

You'll want to implement a custom widget in pretalx/common/forms/widgets.py, where you can also see examples. Please note that this should provide a safe fallback for users who block JavaScript execution.
Static files can be added in pretalx/static/common/, but should only be included in views with forms in the cfp and agenda parts of pretalx. In the orga app, you can include these parts in the pretalx/orga/templates/orga/base.html parent template, as basically every page in this area contains forms.

A challenge will be the proper inclusion of multi-language forms, so please make sure to test with events with a single active language and multiple active languages.

Submit the PR

There are a number of tutorials on the Pull Request workflow online, for example this short version by GitHub itself and this more in-depth tutorial.

Remember to provide documentation and tests, if applicable. Run the tests before opening your PR, including style checks. We have a contribution guide, which ought to prove helpful at this stage.

@rixx rixx added size: small Easy and/or quick to do size: big or difficult Will take a long time and/or a lot of skill type: feature stage: up for grabs labels Mar 31, 2018
@rixx rixx removed the size: small Easy and/or quick to do label Sep 12, 2018
@obilodeau
Copy link

I wanted to note here that there is a way to preview your submission, it's just that you need to complete it first and then you can use the share submission link also called Copy Code for Review in the "My Submissions" section. There the markdown is rendered like reviewers would see it.

@rixx rixx added help wanted A default GitHub label inviting outside help good first issue A default GitHub label inviting first time contributors labels May 1, 2019
@rixx rixx added stage: wip This issue is being worked on and removed good first issue A default GitHub label inviting first time contributors help wanted A default GitHub label inviting outside help stage: up for grabs labels May 17, 2019
@rixx rixx closed this as completed in 4508ca1 May 17, 2019
@rixx
Copy link
Member Author

rixx commented May 17, 2019

Screenshot_2019-05-17  foo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: big or difficult Will take a long time and/or a lot of skill stage: wip This issue is being worked on type: feature
Projects
None yet
Development

No branches or pull requests

2 participants