search

mozilla / mentat

UNMAINTAINED A persistent, relational store inspired by Datomic and DataScript.
https://mozilla.github.io/mentat/
Apache License 2.0
1.65k stars 115 forks source link

[website] Add GitHub pages and get mentat.github.io if possible #748

Open ncalexan opened 6 years ago

ncalexan commented 6 years ago

I see that github.com/mozilla/application-services is using Docusauras at https://github.com/mozilla/application-services/tree/master/website, which looks nice enough. @grigoryk was arguing in favour of Jekyll, IIRC. @fluffyemily do you have strong feelings?

grigoryk commented 6 years ago

To be clear, I have no very strong preference. I've had good luck with Jekyll in the past on some personal projects. For our needs (a simple landing page, some structured docs and examples, a few nested pages with perhaps a couple of templates at most) I reckon that most anything that isn't a pain to use will suffice.

fluffyemily commented 6 years ago

I don't have a strong preference, but looking at the documentation for both it seems as if Jekyll is better at hosting static HTML pages whereas Docusaurus is better for more custom pages. Seeing as a large amount of our documentation is going to HTML generated by swiftdoc, javadoc and rustdoc I'm going to go with Jekyll, at least initially. Moving to Docusaurus later doesn't seem too onerous.

On 19 June 2018 at 19:56, Grisha Kruglov notifications@github.com wrote:

To be clear, I have no very strong preference. I've had good luck with Jekyll in the past on some personal projects. For our needs (a simple landing page, some structured docs and examples, a few nested pages with perhaps a couple of templates at most) I reckon that most anything that isn't a pain to use will suffice.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/mozilla/mentat/issues/748#issuecomment-398507922, or mute the thread https://github.com/notifications/unsubscribe-auth/AMB1uC903AKorEYVmqumIgKMTCvNIlgPks5t-UlvgaJpZM4UsRFw .

fluffyemily commented 6 years ago

So, It seems we already have a pages https://mozilla.github.io/mentat/ site already set up that is serving from our /docs directory. If we want mentat.github.io we will have to create another organization called Mentat. I will set it up at our default location.

On 20 June 2018 at 15:48, Emily Toop etoop@mozilla.com wrote:

I don't have a strong preference, but looking at the documentation for both it seems as if Jekyll is better at hosting static HTML pages whereas Docusaurus is better for more custom pages. Seeing as a large amount of our documentation is going to HTML generated by swiftdoc, javadoc and rustdoc I'm going to go with Jekyll, at least initially. Moving to Docusaurus later doesn't seem too onerous.

On 19 June 2018 at 19:56, Grisha Kruglov notifications@github.com wrote:

To be clear, I have no very strong preference. I've had good luck with Jekyll in the past on some personal projects. For our needs (a simple landing page, some structured docs and examples, a few nested pages with perhaps a couple of templates at most) I reckon that most anything that isn't a pain to use will suffice.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/mozilla/mentat/issues/748#issuecomment-398507922, or mute the thread https://github.com/notifications/unsubscribe-auth/AMB1uC903AKorEYVmqumIgKMTCvNIlgPks5t-UlvgaJpZM4UsRFw .

ncalexan commented 6 years ago

So, It seems we already have a pages https://mozilla.github.io/mentat/ site already set up that is serving from our /docs directory. If we want mentat.github.io we will have to create another organization called Mentat. I will set it up at our default location.

I did this yesterday, when I couldn't figure out how to get mentat.github.io, but now I see how to do it. Please push that through!