search

Islandora / documentation

Contains islandora's documentation and main issue queue.
MIT License
104 stars 71 forks source link

Update Islandora fork of Material for MkDocs Insider theme #1915

Open eldonquijote opened 2 years ago

eldonquijote commented 2 years ago

Islandora documentation uses the Material for MkDocs theme (https://squidfunk.github.io/mkdocs-material/). We payed for access to the 'Insider' version of the theme, which includes advanced features like versioning support (https://squidfunk.github.io/mkdocs-material/insiders/#exclusive-features). In order for the documentation site generator to use the Insider theme version, @dannylamb was able to create a private fork of the theme author's Insider repository (https://github.com/Islandora/mkdocs-material-insiders).

Our fork should be updated to the most current version of the Insider repository, so that we have access to the most current features the theme offers.

Possible contingencies: Issue #1914 suggests to move documentation page generation from Travis CI to Github Actions. AFAIK a reason for forking the Insider theme repository was that the current Travis-based workflow to compile static HTML pages couldn't get access to the official Material for MkDocs Insider repository. Perhaps this works with GH Actions?

rosiel commented 2 years ago

I think @dannylamb might be the only one at the moment with access to https://github.com/squidfunk/mkdocs-material-insiders

eldonquijote commented 2 years ago

I looked a bit closer at the Travis configuration and I'm not so sure anymore if Travis actually builds the documentation web pages using the fork: https://github.com/Islandora/documentation/blob/3de08cb6be3a97e174d372206f8a3f853a4b322d/.travis.yml#L14 (IIUC, this line is executed when Travis builds the pages).

@dannylamb, is the Github token referenced in .travis.yml a personal token? I vaguely remember that you might not have been able to send money to the Material theme author through the GH sponsorship feature using the Islandora organization account, is that correct?

adam-vessey commented 1 year ago

With #2212 being merged, has this been addressed?

Had some discussion around what the "insiders" theme was being used for, and it seemed the particular features ("table of contents" generation seemed to be the big highlight?), have since been pushed out to the base "material" theme, and as such, #2212 dropped the usage of the "insiders" theme. Maybe this issue is no longer relevant?

rosiel commented 1 year ago

We can probably stop paying for the insiders theme, since it seems we're not using any of the features. @dannylamb

While we're at it - we could look at implementing versions in the docs which is now a core feature (not insiders)