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

Transition Vue app to read (and write?) markdown fields from graphql API #623

Open
5 tasks done
ngottlieb opened this issue Jan 20, 2025 · 2 comments
Open
5 tasks done
Assignees

Comments

@ngottlieb
Copy link
Contributor

ngottlieb commented Jan 20, 2025

Purpose is to migrate fully to the markdown API so we can be fully consistent with the React Native app.

Read markdown fields:

  • posts.detail_md
  • reaches.description_md, reaches.gaugeinfo_md, reaches.shuttledetails_md
  • accidents.description_md
  • rapids.description_md
  • posts_photos.description_md (TBD)

Writing markdown fields — applies to same fields, but remains an open question, particularly surrounding what we want the edit interface to look and feel like. We likely don't want users having to actually type in Markdown as one would with a standard Markdown editor, so need a rich text editor that outputs markdown.

@ngottlieb ngottlieb self-assigned this Jan 20, 2025
@ngottlieb
Copy link
Contributor Author

Some things worth noting as I work on this:

  • while alerts can hold HTML via the data model, in practice, they are generated using a plain text field, not a rich editor. If/when these get remodeled away from the overloaded posts table, we can do away with the markdown caveat here
  • reaches.gaugeinfo and reaches.shuttledetails are not currently accessible in the Vue app
  • accidents.description_md is not used by the Vue app as we just display a table and link to existing Laravel (and, soon, Wordpress) details

@ngottlieb
Copy link
Contributor Author

After a discussion on Slack with @tallowen, decided to move forward with the "read Markdown fields" portion of this task first, and then to coordinate with @drewalth on a rich Markdown text editor as he gets closer to implementing that on the frontend.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant