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

Success Stories submission form - Add help text requesting Markdown formatting to the Content box #2364

Open
loren-c opened this issue Feb 8, 2024 · 1 comment · May be fixed by #2594
Open
Assignees
Labels
backend Relates to the backend of the app frontend Relates to the frontend of the app
Milestone

Comments

@loren-c
Copy link
Contributor

loren-c commented Feb 8, 2024

Is your feature request related to a problem? Please describe.
When users use the Success Stories submission form to submit a success story, there is currently no guidance on whether to submit Success Stories in plain text or a mark up language. It's much faster on our end to post stories if they are submitted in Markdown so we don't have to format them ourselves.

Describe the solution you'd like
I'd like for there to be help text next to the Content text entry box on the Success Stories form indicating Markdown is preferred.

Describe alternatives you've considered
Currently we either reach out to request the submitter put their submission into Markdown after we receive it or we put it in Markdwown ourselves.

Additional context
Suggested text to add to the Success Stories submission form is:
"Submissions in Markdown are strongly preferred and can be processed more quickly" as shown in the attached screenshot in red.
(I'm not 100% sure that wording is the accurate way to describe text being "in Markdown"; please edit if it doesn't quite make sense as I've written it. Thank you!)
Screenshot of pythondotorg successs story form

@ewdurbin

@ewdurbin ewdurbin self-assigned this Feb 8, 2024
@JacobCoffee JacobCoffee added frontend Relates to the frontend of the app backend Relates to the backend of the app labels Sep 16, 2024
@JacobCoffee
Copy link
Member

first glance: I believe this would be done in or around

class StoryForm(ContentManageableModelForm):

@JacobCoffee JacobCoffee added this to the 2H24 milestone Sep 16, 2024
@JacobCoffee JacobCoffee assigned JacobCoffee and unassigned ewdurbin Sep 19, 2024
JacobCoffee added a commit that referenced this issue Sep 19, 2024
@JacobCoffee JacobCoffee linked a pull request Sep 19, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Relates to the backend of the app frontend Relates to the frontend of the app
Projects
Status: Starting Soon
Development

Successfully merging a pull request may close this issue.

3 participants