mitre-attack / mitre-attack/attack-website

Update Pelican webassets plugin

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

Nobody has claimed this yet.

Dominant language
HTML
Stars
588
Forks
174
Avg merge
13d 4h
Merged PRs (30d)
2

Description

We've been using a Pelican plugin for webassets for about 5 years by vendoring it here: https://github.com/mitre-attack/attack-website/tree/master/plugins/assets

This has caused it to become stale, while Pelican itself has updated their plugin approach to favor namespace plugins instead of the legacy format (https://docs.getpelican.com/en/stable/plugins.html#where-to-find-plugins)

The latest webassets plugin can be found here: https://github.com/pelican-plugins/webassets, which can be installed with python -m pip install pelican-webassets and therefore will be much easier to maintain.

This is worth looking into for the sake of maintainability.

Contributor guide

Open the contributing guide

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

Start with the vendored plugin under plugins/assets and the Pelican plugin documentation, then inspect how the site currently loads it. Try installing pelican-webassets with python -m pip and verify the site build using the namespace plugin. Done means the stale vendored plugin is no longer needed and the website still builds with webassets support.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.