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

Generate website from README. #42

Open
5 tasks done
Anish-Agnihotri opened this issue Mar 15, 2019 · 7 comments
Open
5 tasks done

Generate website from README. #42

Anish-Agnihotri opened this issue Mar 15, 2019 · 7 comments

Comments

@Anish-Agnihotri
Copy link

Anish-Agnihotri commented Mar 15, 2019

As the README.md grows, it's important to keep it organized, and the information easily accessible for the average reader. In addition, with the addition of more complex topic (think: Continuous organizations), having the option to present information in larger summaries would be beneficial.

This issue aims to highlight a potential way that this issue could be alleviated: through the creation of a website that simply compiles the information from the README.md into an easily readable wiki-format (think similar to what EthHub has done).

Requirements:

  1. The README.md is cleaned up and put into proper order.
  2. The README.md is potentially broken up into separate paginated parts.
  3. All changes in the README.md automatically generate a website hosted with Github Pages.

Definition of done

  1. A github pages website is live featuring the content from the README.md, with an easy way to add information by simply editing the source markdown files.
  2. There is an easy way to add longer summaries for content.
@owocki
Copy link

owocki commented Mar 15, 2019

i'd be curious to see a MVP of a better solution here..

@Anish-Agnihotri
Copy link
Author

I'll whip up a quick MVP today.

@Anish-Agnihotri
Copy link
Author

Alright, figured out all the kinks, CI integration, etc.

Let me know if you want me to make a PR.

@owocki
Copy link

owocki commented Mar 18, 2019

mind posting the link again? what do you need me to do to enable you to hook it up to FEMBusinessModelsRing.github.io ?

@Anish-Agnihotri
Copy link
Author

Here is the link to the WIKI. I'll do some final cleanup tonight and make sure everything works (images, metadata, etc.).

I think the only thing that would need to be done is a merge script run by something like Travis. So, when a contributor makes a PR and submits, Travis automatically recompiles the wiki and deploys to Github pages.

So the needs would be:

  1. Add Travis to this repo.
  2. Add the build script I'll write-up to Travis.
  3. I'll submit a PR for you to merge that has the new file structure.

Other than that, let me see if there is a way to deploy the github pages without Travis. I doubt there is, but I'd like to make sure (since this should be as simple as possible).

@owocki
Copy link

owocki commented Mar 18, 2019

@Anish-Agnihotri i just invited you to this organization. when u join u should have all the permissions needed to set this up

@Anish-Agnihotri
Copy link
Author

Sweet, sounds good. I’ll set it up and get it running in the morning tomorrow.

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

No branches or pull requests

2 participants