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

Updated readme, to reflect new changes #73

Closed
wants to merge 2 commits into from

Conversation

ajmas
Copy link
Collaborator

@ajmas ajmas commented Nov 16, 2017

Process changes, so we needed to update the documentation. Also, taking the opportunity to make it clearer

@ajmas ajmas requested review from RichardLitt and pcuci November 16, 2017 18:04
----------------

If you are adding yourself or removing yourself as a
mentor, you should create a PR request, first having modified
Copy link
Member

Choose a reason for hiding this comment

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

Against which branch?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That was stated in a section below, but we can put it in this section.

Copy link
Member

Choose a reason for hiding this comment

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

Noticed that. This is fine.

------------

Remember when making your pull request (PR) to do it against
the [gh-pages-src](https://github.com/nodeschool/montreal/tree/gh-pages-src) branch. Doing anything else will most definitely
Copy link
Member

Choose a reason for hiding this comment

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

Why do we have other branches? Can we just have the one, or at the least set it as the default?

Copy link
Collaborator Author

@ajmas ajmas Nov 16, 2017

Choose a reason for hiding this comment

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

Not sure why we have both master and gh-pages? As for gh-pages-src, this is where we are publishing from to gh-pages, as part of the Travis CI process. I wanted to do the changes incrementally, until I had feedback from the relevant people.

We could change things up, such that master and gh-pages-src are merged into one branch and that we publish to gh-pages. I don't want to do this until I have an okay from @pcuci

GitHub does not support i18n at this point. There is the following open issue tracking this: github/pages-gem#401

Copy link
Member

Choose a reason for hiding this comment

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

Then let's remove master, or, better, remove gh-pages-src and rename it to master, and just have people push all commits against master, which would then generate gh-pages automatically. I think this is a more common flow. @pcuci sound good?

Copy link
Member

Choose a reason for hiding this comment

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

@ajmas Can we go with this flow, then?

Copy link
Member

Choose a reason for hiding this comment

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

Needs to be updated.

@pcuci
Copy link
Member

pcuci commented Nov 21, 2017

The NodeSchool.io/montreal site relies on a gh-pages* branch, IIRC

Do as you please, no need to loop me in, all is revertable :-)

@ajmas
Copy link
Collaborator Author

ajmas commented Nov 21, 2017

Based on a conversation with Richard we will make the master branch the source branch and gh-pages the published branch. This may also make it more convenient for new mentors, since this will mean only one branch needs updating.

@ajmas
Copy link
Collaborator Author

ajmas commented Nov 21, 2017

Closing PR, since we need to do this against another branch. Note README.md updated in master, let me know if there any changes that need to be made there or you can do changes yourself.

@ajmas ajmas closed this Nov 21, 2017
@RichardLitt
Copy link
Member

I'm not seeing another PR. This stuff is all still needed in the README, innit?

@ajmas ajmas deleted the readme-update branch April 27, 2018 21:04
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.

3 participants