jQPlot icon indicating copy to clipboard operation
jQPlot copied to clipboard

Converting the gh-pages branch content to jekyll

Open RubenOlsen opened this issue 9 years ago • 6 comments

Problem description

Using Github Pages for the documentation makes better sense that the wiki for several reasons, but not limited to:

  • Easier to maintain on a technical level. The tool-support is better handling files, than using a web-brower to update a wiki.
  • Having the possibility to generate API docs, rather than manually updating information. Manual updates will never be "up-to-date".
  • We need a good alternative to the old jQplot web-pages - Github Pages are the answer.
  • A well structured website it easier to navigate than a wiki. Wikis have their place with regards to documentation - but maybe not for the kind of documentation we need which is API and interactive examples.

Todo

Convert the current gh-pages to jekyll.

Done criteria

When the current gh-pages are jekyll-ified without changing the current look and feel

Things to keep in mind

We must document in the CONTRIBUTING.md file (#44) what kind of documentation goes where.

RubenOlsen avatar Aug 08 '15 11:08 RubenOlsen

Agreed! So until @svandecappelle makes you a contributor, I suggest starting to build the Jekyll docs in a fork.

johanbove avatar Aug 08 '15 14:08 johanbove

Added to contributor ;) Thanks for supporting the renew of jqplot ;)

svandecappelle avatar Aug 08 '15 15:08 svandecappelle

I have given the question with regards to when to use the wiki and when to use the GH pages for documentation.

My suggestion is as follows: How about we use wiki-pages for documenting everything that has to do with the development of jQPlot, while the GH pages deals with everything that has to do with how to use jQPlot in your own project.

If this makes sense, this information should be present in the CONTRIBUTING.md (see #44).

RubenOlsen avatar Aug 09 '15 10:08 RubenOlsen

It seems that broken CSS style too =)

Fonts of header h2.plain Images

svandecappelle avatar Aug 10 '15 08:08 svandecappelle

Now we are talking about taste.

My reasons for using class="plain" inside the documentation is that a swigly font is not always appropriate. Documentation should be easy to read, a swigly headings is not easy to read.

I have created #52 to fix some CSS issues - I'll see what I'm going to do with the headers. I think we should keep the swigly fonts on the front page and on the main documentation pages - but use a plain font for the headers inside the documentation pages.

RubenOlsen avatar Aug 10 '15 09:08 RubenOlsen

I think we should keep the swigly fonts on the front page and on the main documentation pages - but use a plain font for the headers inside the documentation pages.

@RubenOlsen: Agree with that

svandecappelle avatar Aug 10 '15 09:08 svandecappelle