JPlag icon indicating copy to clipboard operation
JPlag copied to clipboard

Enhance public appearance of JPlag

Open sebinside opened this issue 2 years ago • 5 comments

After the maintenance team changed from IPD to KASTEL, we chose to drop the legacy website of JPlag that was not up to date at all. However, JPlag shall have at least a landing page and some documentation to get interested people started (also related to #109). This issue serves as a placeholder to discuss this, the realization will probably start around Q2 2022 (requires at least #192).

The current approach is to make it lightweight and markdown-friendly, e.g., by using Docosaurus together with GitHub pages and migrating the current wiki.

Possible features (please add!):

  • [ ] Landing page with a quick overview and download links (direct, GitHub release, maven) and quick help
  • [x] Wiki (migrated and enhanced, e.g., drawing a real AST 😮)
  • [ ] A discussion of ethics and when not to use JPlag (e.g., small algorithm tasks)
  • [x] Sample reports and downloadable testing data
  • [x] A web viewer based on #192
  • [ ] DOs and DONTs
  • [ ] A glossary that explains common JPlag terminology, e.g., submission and match
  • [ ] A "used by" section? Do we have enough validated information?
  • [x] Credits
  • [ ] Publicly available demonstration material like videos or screencasts

An archived version of the old Jplag website can be found here.

sebinside avatar Jan 11 '22 11:01 sebinside

@sebinside you might also have a look at jekyll

  • https://jekyllrb.com/docs/pages/
  • https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll

dfuchss avatar Feb 13 '22 22:02 dfuchss

@dfuchss Yes, i know about jekyll, but finding really good templates is surprisingly hard :)

sebinside avatar Feb 14 '22 19:02 sebinside

Maybe also have a look at sphinx. This works good as well

dfuchss avatar May 05 '22 21:05 dfuchss

I've created a proposal in #470 :D

dfuchss avatar Jun 27 '22 21:06 dfuchss

Current plan is to deploy Wiki directly from the repo, see:

  • https://github.com/kit-sdq/programming-lecture-eclipse-artemis/blob/main/.github/workflows/docs.yml
  • https://github.com/kit-sdq/programming-lecture-eclipse-artemis/tree/main/docs
  • https://github.com/kit-sdq/programming-lecture-eclipse-artemis/wiki

tsaglam avatar Mar 31 '23 08:03 tsaglam