OpenFreeEnergy / OpenFreeEnergy/openfreeenergy.github.io

Change URL for news items?

Open
#47 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
2
Forks
3
Avg merge
6h 59m
Merged PRs (30d)
2

Description

Right now, our URLs for news items include the "categories" (which we're actually treating as unordered tags). Example, a URL with categories lomap and release gives:

https://openfree.energy/lomap/release/2022/03/15/lomap-conda-forge/

Since we don't have a defined ordering on these, this could just as easily have been release/lomap/2022/03/15/lomap-conda-forge/. I think we should change this. Two ways to change (both about equally easy):

  1. Distinguish between actual categories and tags. Each post must have 1 category. Possible categories include:

    • releases
    • hirings
    • presentations
    • science
    • misc

    We aren't locked into any set; we can always add more categories later as needed. This could be nice from a URL standpoint because we could have openfree.energy/releases/ as an index with all releases, and then within it openfree.energy/releases/2022/03/15/lomap-conda-forge/ .

  2. Completely remove these labels from the URL. In this case, I'd probably want to add news/ as a level, and the URL would be openfree.energy/news/2022/03/15/lomap-conda-forge/

Either solution should be easy to implement (probably took me longer to write this issue).

Note that changing the URLs will break any existing links to them... but I highly doubt we have many incoming links to our 2 little news items.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The payload names no files, tests, or entry points, so first locate the site's news-item URL generation and inspect the existing news links. Resolve whether to distinguish categories from tags or remove labels in favor of a news/ path, then verify that the existing news items use the selected URL structure.

Written by the indexing model from the issue text.

Assessment

Domain
web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.