openlibhums / openlibhums/janeway

Deprecate core custom styling features

Open
#3,596 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dev-ready documentation Priority high Size L
Dominant language
Python
Stars
238
Forks
97
Avg merge
9d 1h
Merged PRs (30d)
8

Description

Describe the area of the documentation you would like updated/added.
The custom styling plugin has functionally replaced older methods of writing custom stylesheets. We should:

  • Check known installations for old-style custom stylesheets and remove them or migrate them to the custom styling framework
  • Check against https://github.com/BirkbeckCTP/customstyling/issues/7 for needed changes to Materialize selectors if not already done. This is only needed in cases where someone doesn't have the customstyling plugin installed, where a data migration is planned to modify affected selectors in all known stylesheet locations.
  • Mark code related to the old style as deprecated, or remove it if possible

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 by reviewing the custom styling plugin and its issue 7, then audit known installations for old-style custom stylesheets and the code related to them. Done means affected installations are migrated or cleaned up, Materialize selector changes are addressed where needed, and the remaining old styling code is deprecated or removed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, frontend
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.