Use jekyll theme for documentation

[TobiasNx]

This seems to be a good option. Changing the blue to the metafacture blue otherwise nice simple documentation form.

https://just-the-docs.github.io/just-the-docs/

It allows for searching and a sidebar.

This page shows how to use this template in github pages: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md

[katauber]

functional review: @TobiasNx code review: ?

[dr0i]

As discussed today we will ask if @Phu2 has time to give it a try.

[Phu2]

Note to self: the docs are published as github pages already, see https://metafacture.github.io/metafacture-documentation/ However, the metafacture site oddly links to the (this!) repo of the docs instead.

[TobiasNx]

Note to self: the docs are published as github pages already, see https://metafacture.github.io/metafacture-documentation/ However, the metafacture site oddly links to the (this!) repo of the docs instead.

This is due to the fact that the gh pages version is not ready yet / did not exist yet and the documentation repo was used instead.

[Phu2]

First draft is published at https://phu2.github.io/metafacture-documentation/ Still need to adjust the navigation and tweak some colors. The site will be re-deployed on push to the master branch of https://github.com/Phu2/metafacture-documentation

[TobiasNx]

Structure: General pages:

• Readme
• Getting Started
• 5 min Intro into MF
• Approaching a transformation with metafacture

FLUX

• Flux User Guide
• Flux Commands

FIX

• Fix-User-Guide
• Fix Functions and Cookbook

Java Integration

• Framework user guide

For Developers

• Documentation-Maintainer-Guide
• License

[Phu2]

Pages restructered, navigation added. @TobiasNx You might want to review the redeployed docs https://phu2.github.io/metafacture-documentation/

• the README.md is left as is for use within the repo
• parts of the README.md were copied to index.md (Home), flux.md, fix.md and so on
• there is no "For Developers" level for now, might add later if needed
• the LICENSE file is replicated as LICENSE.md for display within the jekyll site

[TobiasNx]

TODOs:

• Use the MF blue
• Move the MF Icon to the top left corner
• Some formatting but I am not sure.

If we are done with this, we could invite the team to have a look at this.

[Phu2]

Done. I also tried to fix all links and added a footer.

[Phu2]

"Approaching a transformation with metafacture" isn't linked to anywhere (and has no heading). Same with "Maintainer Guide".

[dr0i]

'Short cheer here - this looks so much better :+1:

[TobiasNx]

Perhaps add the word documentation under the logo in the corner?

Also any way to turn [!NOTE] into

Seems like there is a way within justthedocs: https://just-the-docs.com/docs/ui-components/callouts/

[TobiasNx]

Also how should we proceed?

[Phu2]

New branch https://github.com/metafacture/metafacture-documentation/tree/28-use-jekyll-theme created + corresponding Github Action (on push) for deployment to http://metafacture.github.io/metafacture-documentation/

[TobiasNx]

Still open merge this with master.

Add a new README.md that links to the documentation and to the markdown pages. Perhaps we should talk to @dr0i and @fsteeg if they are okay with the remodelling of the documentation repo.

[fsteeg]

The page at http://metafacture.github.io/metafacture-documentation/ looks good to me, but the PR at https://github.com/metafacture/metafacture-documentation/pull/43 is still a draft and has not been reviewed (and is not linked to this issue). Shouldn't this go through the regular review process?

[TobiasNx]

The page at http://metafacture.github.io/metafacture-documentation looks good to me, but the PR at #43 is still a draft and has not been reviewed (and is not linked to this issue). Shouldn't this go through the regular review process?

I opened an PR for this and assigned you for review.