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

Website refactor (flask) #74

Open
VeckoTheGecko opened this issue May 21, 2023 · 3 comments
Open

Website refactor (flask) #74

VeckoTheGecko opened this issue May 21, 2023 · 3 comments

Comments

@VeckoTheGecko
Copy link
Contributor

The site currently has data and content intertwined with each other in the HTML making the site a bit difficult to maintain/grow.

I propose to introduce flask with Frozen-Flask to provide tooling to make the site easier to oversee, maintain, and extend.

Main changes:

  • Convert index.html and utrechtteam.html to templates
    • abstract out the bulk of the data on papers, and team members into yaml files. During build, this data is populated into the templates
  • Other pages remain untouched
  • Markdown support (flask-markdown) which compiles md to HTML during build
    • Markdown files can be included directly in the website
    • Markdown can be written directly within the HTML files

Everything according to plan, building the site will create the exact same website files that currently exist. I'm already familiar with this tooling, so this PR shouldn't take me too long to implement.

Blocked by #73

@erikvansebille
Copy link
Member

Thanks @VeckoTheGecko, for this suggestion for a complete change in the workflow. Maybe you're right that we need a more flashy ('flasky') workflow for the website, but I'm kind of fond of the simpleness of pure html. Call me old-fashioned? In any case, I think this has much lower priority than some of the stuff for the Parcels documentation? Who knows, we might end up with all the Parcels info served through sphinx/parcels-docs anyways?

@VeckoTheGecko
Copy link
Contributor Author

Sounds good. Definitely a lower priority 🙂. Just wanted to also flag it in case there were plans in future to broaden the scope of the website.

@VeckoTheGecko VeckoTheGecko closed this as not planned Won't fix, can't repro, duplicate, stale May 23, 2023
@VeckoTheGecko VeckoTheGecko reopened this Jul 26, 2024
@VeckoTheGecko
Copy link
Contributor Author

VeckoTheGecko commented Jul 26, 2024

Original idea still stands for the most part (will likely still go with flask, but also might do something else), but things to note are:

  • Using a data file of DOIs to get metadata, and to generate the HTML for list of papers mentioning parcels (also check that it is decent quality)
  • Try find the same theme (in a way that any accessibility/most of the HTML is handled by theme maintainers upstream reducing our maintainence)
  • Keep the page structure the same (avoid breaking any links)
  • Improve accessibility

@VeckoTheGecko VeckoTheGecko self-assigned this Jul 26, 2024
@VeckoTheGecko VeckoTheGecko removed their assignment Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

2 participants