Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Converting the gh-pages branch content to jekyll #45

Open
RubenOlsen opened this issue Aug 8, 2015 · 6 comments
Open

Converting the gh-pages branch content to jekyll #45

RubenOlsen opened this issue Aug 8, 2015 · 6 comments
Assignees

Comments

@RubenOlsen
Copy link
Collaborator

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.

@johanbove
Copy link
Collaborator

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

@svandecappelle
Copy link
Owner

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

@RubenOlsen RubenOlsen self-assigned this Aug 8, 2015
@RubenOlsen RubenOlsen added this to the Github Pages - Rev 1 milestone Aug 8, 2015
@RubenOlsen
Copy link
Collaborator Author

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).

@svandecappelle
Copy link
Owner

It seems that broken CSS style too =)

Fonts of header h2.plain
Images

@RubenOlsen
Copy link
Collaborator Author

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.

@svandecappelle
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants