cfe-lab / cfe-lab/bblab-server

Replace wiki with static site

Open
#10 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

The django-wiki library has a breaking change from v0.5 to v0.6 in Bootstrap v4 (see here). This upgrade breaks the wiki layout, and an update to CSS class names is likely necessary to continue with a newer version of django-wiki.

Rather than continue to maintain the wiki, we can convert this site to a set of static pages, perhaps using Jekyll.

A static site should be feasible as changes to the site have been infrequent and most likely do not require a wiki with multiple users. Using a static page will have the added benefit of making the database much simpler.

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

Start by reviewing the current django-wiki integration and how the existing site content is organized. Compare a Jekyll-based static site with the current setup, including the proposed database simplification. Done means the wiki has been replaced by maintainable static pages without the Bootstrap compatibility problem.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll, python
Domain
documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.