Static HTML Website for Bugmark-Docs

bugmark / bugmark_cl

Bugmark Command Line Client

0 stars 3 forks source link

Static HTML Website for Bugmark-Docs #61

Open andyl opened 6 years ago

andyl commented 6 years ago

We need a website for our documentation bugmark/bugmark_docs

We're fans of static HTML generators - jekyll and middleman for websites, mkdocs for documentation.

See related issue #60

akshitac8 commented 6 years ago

Hey @andyl, I would like to contribute. I a good with documentation and have experience with jekyll and pelican. I wanted to get a insight on how should I proceed. It would be great to get some additional info. Thanks

andyl commented 6 years ago

@akshitac8 - tell me about pelican I've never heard of that one

akshitac8 commented 6 years ago

@andyl, Pelican is a static site generator that supports Markdown. It is famous among python developers. I have used it to make a blog-site at ChannelCS Blog.

andyl commented 6 years ago

@akshitac8 - thanks for that. Here's what I will do as a next step:

[ ] study Pelican and talk to you about Pelican vs Jekyll
[ ] look at the current state of our docs site and post a series of issues with deliverables
[ ] think about ML applications for Bugmark and discuss w/u

For a summer project would you be interested in something like this?

learn Bugmark by creating documentation and tutorials
use your docco and tutorials to teach someone to use Bugmark
build a ML trading agent and write a paper about it

Tomorrow I've got a training session and a talk, Thurs/Fri/Sat a conference. Sunday is probably going to be recovery day. So if I go silent for the next few days, that's what is going on. I'll have more time next week to dig into this with you. ;-)

akshitac8 commented 6 years ago

@andyl I am definitely looking forward to work on these with you. I wanted to ask, is their any issue on which I can work with for the outreachy's mozilla round to update my contributions list for the same. Thanks :)

akshitac8 commented 6 years ago

Hey @andyl any update in this bug?

GeorgLink commented 6 years ago

@akshitac8 please see andy's previous message that he will be out of town for a few days.

akshitac8 commented 6 years ago

Ok @GeorgLink As I am participating in outreachy this year so that's why I thought It would be great If I could work on an issue for completing my application.nde I totally understand the busy schedule of @andyl. Feel free to respond whenever free. Thank you :)

GeorgLink commented 6 years ago

@akshitac8 Thank you for being understanding.

akshitac8 commented 6 years ago

@GeorgLink No problem :slightly_smiling_face:

akshitac8 commented 6 years ago

Hello @andyl can I get an update on this?