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

Serve a webpage along with README #60

Closed
kspviswa opened this issue Jan 23, 2018 · 8 comments
Closed

Serve a webpage along with README #60

kspviswa opened this issue Jan 23, 2018 · 8 comments
Assignees

Comments

@kspviswa
Copy link

Hey Nikitha,

Thought to have a static live webpage, than a READ.ME file. So, I just forked your repo and enabled github-pages on my repo, selected timeline theme and tweaked your READ.ME to include past year details automatically in the main index.html, which will get rendered automatically from master branch.

You can view the generated live page here : https://kspviswa.github.io/tech-conferences-india/ .

Have a look & let me know if you want a PR from me.

@arush-sal
Copy link
Contributor

@kspviswa The webpage does look pretty nice 😍 👍

@nikhita
Copy link
Owner

nikhita commented Jan 25, 2018

Thanks for this, @kspviswa! I am travelling right now so I just wanted to let you know that it might be a few days until I can get a deeper look at this. But it looks good on a high level! 👍

@nikhita
Copy link
Owner

nikhita commented Jan 28, 2018

@kspviswa I have had the idea of creating the website in the back of my mind but didn't have the time to do so. I like your website as well, but I'd like two main things/changes here:

  • the website should not be an exact mirror of the README. The idea is that the website should provide some more benefits over the README.
  • another theme, maybe? But that's just me. :)

I have some ideas about the website and I'll probably get it in a couple of weeks. Will ping you for a review surely. 👍

@nikhita nikhita self-assigned this Jan 28, 2018
@nikhita nikhita changed the title Serving static webpage, instead of READ.ME Serve a webpage along with README Jan 28, 2018
@kspviswa
Copy link
Author

@nikhita , the main intent here for me is "automation". Serving a static webpage out of READ.ME automatically is the key. Since the main mode of contribution to this repo is via read.me file , as & when new conference details gets merged to READ.ME file, new content will get automatically served by Github. That's the key. Putting up a website with more details etc would be a different ball game altogether.

Finally, if you are not gonna need this PR as of now, then let me know if I can go-ahead and publishing this webpage as part of my blog.

Cheers!

@nikhita
Copy link
Owner

nikhita commented Jul 4, 2018

Finally, if you are not gonna need this PR as of now, then let me know if I can go-ahead and publishing this webpage as part of my blog.

Sorry for replying so late!

I would like to get to a webpage at some point but I don't have the bandwidth for it right now. I am fine with the README for now.

I would like to have a proper website for this repo; but I am not opposed to you publishing it on your website. However, please provide proper attribution back to this repo on your website.

I see that it references https://github.com/kspviswa/tech-conferences-india, which is ok, but if you are basing off a website off the list of conferences from this repo, it's only fair if you provide proper attribution as well.

@kspviswa
Copy link
Author

kspviswa commented Jul 8, 2018

Hey @nikhita,

I don't intend to plagiarize your work. I just did that to demonstrate automatic webpage generation from READ.ME . That's the reason, I have never referred this or published a blog post etc. I'll take it down if you feel so. Let me know.

@kspviswa
Copy link
Author

kspviswa commented Jul 8, 2018

@nikhita ,

I took it down.

@kspviswa kspviswa closed this as completed Jul 8, 2018
@nikhita
Copy link
Owner

nikhita commented Jul 8, 2018

@kspviswa I don't mind if you keep it, just referencing it back here would be ok :)

Sorry if I came off rudely, text is not the best way of conveying/communication. :)

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