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

[#247] Update site README with more detailed instructions #255

Merged
merged 1 commit into from
Mar 15, 2017

Conversation

leobauza
Copy link
Contributor

Addresses 1 item of #247

This PR adds more details on the contents of the site folder, more detailed instructions, and some background about technologies being used.

## Publish

From the project root:
Publishing to `http://code.viget.com/microcosm` can only be done by core contributors with merging privileges. If this is you then publishing is straightforward, from the project root:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there other reasons to use the publish script? Contributors shouldn't submit PR's from the gh-pages branch right? We will generate the site ourselves when it's ready.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is correct. I don't think there is a reason for a non-managing contributor to use the publish script.

@leobauza leobauza requested a review from nhunzaker March 13, 2017 03:44
Copy link
Contributor

@nhunzaker nhunzaker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fantastic. Thank you for putting this together!

👍

@leobauza leobauza merged commit f53795a into vigetlabs:master Mar 15, 2017
@leobauza leobauza deleted the docs/site branch April 14, 2017 22:53
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

Successfully merging this pull request may close these issues.

2 participants