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

Closed
loren-c opened this issue Feb 8, 2024 · 1 comment · Fixed by #2594
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
@github-project-automation github-project-automation bot moved this from Starting Soon to Complete in Staff and Board Requests Sep 20, 2024
JacobCoffee added a commit that referenced this issue Sep 24, 2024
* fix: display active events, fix time not displaying for some events (#2556)

* fix: display active events, fix time not displaying for some events

* test: passing events view tests

* style: different icon

* Update views.py

Co-authored-by: Ee Durbin <[email protected]>

---------

Co-authored-by: Ee Durbin <[email protected]>

* Bump django-admin-interface from 0.24.2 to 0.28.9 (#2589)

Bumps [django-admin-interface](https://github.com/fabiocaccamo/django-admin-interface) from 0.24.2 to 0.28.9.
- [Release notes](https://github.com/fabiocaccamo/django-admin-interface/releases)
- [Changelog](https://github.com/fabiocaccamo/django-admin-interface/blob/main/CHANGELOG.md)
- [Commits](fabiocaccamo/django-admin-interface@0.24.2...0.28.9)

---
updated-dependencies:
- dependency-name: django-admin-interface
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jacob Coffee <[email protected]>

* Bump django-pipeline from 3.0.0 to 3.1.0 (#2549)

Bumps [django-pipeline](https://github.com/jazzband/django-pipeline) from 3.0.0 to 3.1.0.
- [Release notes](https://github.com/jazzband/django-pipeline/releases)
- [Changelog](https://github.com/jazzband/django-pipeline/blob/master/HISTORY.rst)
- [Commits](jazzband/django-pipeline@3.0.0...3.1.0)

---
updated-dependencies:
- dependency-name: django-pipeline
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump factory-boy from 3.2.1 to 3.3.1 (#2548)

Bumps [factory-boy](https://github.com/FactoryBoy/factory_boy) from 3.2.1 to 3.3.1.
- [Changelog](https://github.com/FactoryBoy/factory_boy/blob/master/docs/changelog.rst)
- [Commits](FactoryBoy/factory_boy@3.2.1...3.3.1)

---
updated-dependencies:
- dependency-name: factory-boy
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix(frontend): add help text to story form (#2594)

* fix(frontend): add help text to story form

Closes #2364

* chore: source migration

* fix: use meta class overrides instead

* feat: linkify

* Bump python-decouple from 3.4 to 3.8 (#2596)

Bumps [python-decouple](https://github.com/henriquebastos/python-decouple) from 3.4 to 3.8.
- [Release notes](https://github.com/henriquebastos/python-decouple/releases)
- [Changelog](https://github.com/HBNetwork/python-decouple/blob/master/CHANGELOG.md)
- [Commits](HBNetwork/python-decouple@v3.4...v3.8)

---
updated-dependencies:
- dependency-name: python-decouple
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jacob Coffee <[email protected]>

* deps: no mo boto (#2598)

* Bump django-tastypie from 0.14.6 to 0.14.7 (#2602)

Bumps [django-tastypie](https://github.com/django-tastypie/django-tastypie) from 0.14.6 to 0.14.7.
- [Release notes](https://github.com/django-tastypie/django-tastypie/releases)
- [Commits](django-tastypie/django-tastypie@v0.14.6...v0.14.7)

---
updated-dependencies:
- dependency-name: django-tastypie
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump cssselect from 1.1.0 to 1.2.0 (#2606)

Bumps [cssselect](https://github.com/scrapy/cssselect) from 1.1.0 to 1.2.0.
- [Changelog](https://github.com/scrapy/cssselect/blob/master/CHANGES)
- [Commits](scrapy/cssselect@v1.1.0...v1.2.0)

---
updated-dependencies:
- dependency-name: cssselect
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chores & docs: clean up some inaccuracies in getting started (#2600)

* chore: remove obsolete version entry from compose

Currently raises a warning:

   the attribute `version` is obsolete, it will be ignored,
   please remove it to avoid potential confusion

Signed-off-by: Mike Fiedler <[email protected]>

* docs: staging site does not exist

Signed-off-by: Mike Fiedler <[email protected]>

* docs: format the link to be clickable

Signed-off-by: Mike Fiedler <[email protected]>

* docs: use what's currently in docker-compose.yml

Signed-off-by: Mike Fiedler <[email protected]>

* docs: remove version specificity

Signed-off-by: Mike Fiedler <[email protected]>

---------

Signed-off-by: Mike Fiedler <[email protected]>

---------

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Mike Fiedler <[email protected]>
Co-authored-by: Ee Durbin <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Mike Fiedler <[email protected]>
ewdurbin added a commit that referenced this issue Sep 30, 2024
* fix: display active events, fix time not displaying for some events (#2556)

* fix: display active events, fix time not displaying for some events

* test: passing events view tests

* style: different icon

* Update views.py

Co-authored-by: Ee Durbin <[email protected]>

---------

Co-authored-by: Ee Durbin <[email protected]>

* Bump django-admin-interface from 0.24.2 to 0.28.9 (#2589)

Bumps [django-admin-interface](https://github.com/fabiocaccamo/django-admin-interface) from 0.24.2 to 0.28.9.
- [Release notes](https://github.com/fabiocaccamo/django-admin-interface/releases)
- [Changelog](https://github.com/fabiocaccamo/django-admin-interface/blob/main/CHANGELOG.md)
- [Commits](fabiocaccamo/django-admin-interface@0.24.2...0.28.9)

---
updated-dependencies:
- dependency-name: django-admin-interface
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jacob Coffee <[email protected]>

* Bump django-pipeline from 3.0.0 to 3.1.0 (#2549)

Bumps [django-pipeline](https://github.com/jazzband/django-pipeline) from 3.0.0 to 3.1.0.
- [Release notes](https://github.com/jazzband/django-pipeline/releases)
- [Changelog](https://github.com/jazzband/django-pipeline/blob/master/HISTORY.rst)
- [Commits](jazzband/django-pipeline@3.0.0...3.1.0)

---
updated-dependencies:
- dependency-name: django-pipeline
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump factory-boy from 3.2.1 to 3.3.1 (#2548)

Bumps [factory-boy](https://github.com/FactoryBoy/factory_boy) from 3.2.1 to 3.3.1.
- [Changelog](https://github.com/FactoryBoy/factory_boy/blob/master/docs/changelog.rst)
- [Commits](FactoryBoy/factory_boy@3.2.1...3.3.1)

---
updated-dependencies:
- dependency-name: factory-boy
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix(frontend): add help text to story form (#2594)

* fix(frontend): add help text to story form

Closes #2364

* chore: source migration

* fix: use meta class overrides instead

* feat: linkify

* Bump python-decouple from 3.4 to 3.8 (#2596)

Bumps [python-decouple](https://github.com/henriquebastos/python-decouple) from 3.4 to 3.8.
- [Release notes](https://github.com/henriquebastos/python-decouple/releases)
- [Changelog](https://github.com/HBNetwork/python-decouple/blob/master/CHANGELOG.md)
- [Commits](HBNetwork/python-decouple@v3.4...v3.8)

---
updated-dependencies:
- dependency-name: python-decouple
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jacob Coffee <[email protected]>

* deps: no mo boto (#2598)

* Bump django-tastypie from 0.14.6 to 0.14.7 (#2602)

Bumps [django-tastypie](https://github.com/django-tastypie/django-tastypie) from 0.14.6 to 0.14.7.
- [Release notes](https://github.com/django-tastypie/django-tastypie/releases)
- [Commits](django-tastypie/django-tastypie@v0.14.6...v0.14.7)

---
updated-dependencies:
- dependency-name: django-tastypie
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump cssselect from 1.1.0 to 1.2.0 (#2606)

Bumps [cssselect](https://github.com/scrapy/cssselect) from 1.1.0 to 1.2.0.
- [Changelog](https://github.com/scrapy/cssselect/blob/master/CHANGES)
- [Commits](scrapy/cssselect@v1.1.0...v1.2.0)

---
updated-dependencies:
- dependency-name: cssselect
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chores & docs: clean up some inaccuracies in getting started (#2600)

* chore: remove obsolete version entry from compose

Currently raises a warning:

   the attribute `version` is obsolete, it will be ignored,
   please remove it to avoid potential confusion

Signed-off-by: Mike Fiedler <[email protected]>

* docs: staging site does not exist

Signed-off-by: Mike Fiedler <[email protected]>

* docs: format the link to be clickable

Signed-off-by: Mike Fiedler <[email protected]>

* docs: use what's currently in docker-compose.yml

Signed-off-by: Mike Fiedler <[email protected]>

* docs: remove version specificity

Signed-off-by: Mike Fiedler <[email protected]>

---------

Signed-off-by: Mike Fiedler <[email protected]>

* fix(#1701): Events page displays year for events scheduled to start or end at a future year (#2500)

* Add Methods To Check If Event Starts And Ends This Year

* Set Up Templates For Querying Start And End Years

Passed variables to the time_tag template [time_tag.html] that checks if an event was scheduled to start or end with the current year.

* Insert New Test Data And Update test_views.py

More events are created to test particular scenarios of events especially events set to start or end at a future year.

* Time Tag Now Shows Year For Events With Details Not Within The Current Year

The time tag now displays the year when an event will occur. This is only for events that have been scheduled to start or end in at a future year. The accompanying functional tests have also been included.

* Move All Test Data To Functional Test

All test data concerning the provision of data to serve the functional tests have been moved to the functional test.
As it improves readability.
All other test data at test_views.py was reset
to accommodate for the reduction in number of test data instances.

* Functional Test For Displaying Year Of Event For Future Events Now Implemented With Unit Tests

* Remove Functional Test For Displaying Year Of Future Event

Since the current CI at the main branch does not support selenium [web driver] operations, the functional test which depends on selenium to run has been removed.

* Handle Case When Call To Next Event Returns None

* Fix Erroneous Addition To Dev Requirements

This error was introduced in 115af08

* Refactor Tests For Relevant Year String Rendering At Events Page

- Updated the test methods `test_scheduled_to_start_this_year_method` and `test_scheduled_to_end_this_year_method` to better reflect event scheduling edge cases.
- Added assertions to verify when events are not scheduled to start or end within the current year.
- Utilize `unittest.mock` to clamp down datetime-sensitive tests.

---------

Co-authored-by: Jacob Coffee <[email protected]>

* infra: enable the waf (#2613)

* fix(infra): use new site names (#2614)

* chore: avoid running Actions twice on PR (#2615)

* chore: avoid running Actions twice on PR

Refs: https://github.com/orgs/community/discussions/57827#discussioncomment-6579237

* chore: run once

* add a static container for handling local frontend dev (#2619)

* add a static container for handling local frontend dev

* resulting css files

* Improve static deploy (#2609)

* Add a utility for purging Fastly by Surrogate-Key

* add a postdeploy step to purge surroage-keys for static files

---------

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Mike Fiedler <[email protected]>
Co-authored-by: Ee Durbin <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Mike Fiedler <[email protected]>
Co-authored-by: Nwokolo Godwin Chidera <[email protected]>
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: Complete
Development

Successfully merging a pull request may close this issue.

3 participants