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

docs as GitHub Pages source folder #278

Merged
merged 10 commits into from
Jun 12, 2017
Merged

Conversation

jackfoxy
Copy link
Collaborator

simpler model to publish project gh pages

@jackfoxy
Copy link
Collaborator Author

This PR related to issue #201 (comment) If there is interest in carrying this forward, I can resolve the merge conflict. This is implemented as a hard cut-over to the simpler model of publishing docs on Github. In other words the gh-pages option would not be available.

@dsyme
Copy link
Contributor

dsyme commented Jun 8, 2017

@jackfoxy @rmunn @pblasucci Do we want to take this forward?

@pblasucci
Copy link
Collaborator

pblasucci commented Jun 8, 2017

@jackfoxy @dsyme @rmunn
I'm fine with this change. A surprisingly high number of folks never even use the documentation features in ProjectScaffold. Maybe a simpler tooling story will change that?

👍

@pblasucci
Copy link
Collaborator

One question, though: how does this relate to #279?

@jackfoxy
Copy link
Collaborator Author

jackfoxy commented Jun 8, 2017

@pblasucci it's been a while. Looks like #279 changes the documentation. I'll get to this on the weekend and make sure both PRs are up to date with current master and still does what I think it does. I've been maintaining my own fork and another fork for my company lately.

@jackfoxy
Copy link
Collaborator Author

jackfoxy commented Jun 8, 2017

BTW, on my other forks I've added tips on retrofitting Project Scaffold to already existing git projects, should I add that to the getting started documentation?

@pblasucci pblasucci closed this Jun 9, 2017
@pblasucci pblasucci reopened this Jun 9, 2017
@pblasucci
Copy link
Collaborator

Whoops! Didn't mean to close. Hit the wrong button (stupid tiny phone keyboard). Anyway...

Thanks @jackfoxy. This is good stuff. And, yes please! If you could include the additional docs, that'd be awesome.

@rmunn
Copy link
Contributor

rmunn commented Jun 9, 2017

👍 from me. I'm not 100% happy with docsraw as the name, but the only alternatives I've come up with so far are docssrc, or possibly docsrc since the two consecutive s characters in docssrc seem strange. But both of those could lead to confusion with src, so although I'm not totally happy with the name docsraw, it's still better than anything I've come up with so far.

@dsyme
Copy link
Contributor

dsyme commented Jun 9, 2017

docsraw isn't great. I suggest src/docs? Not ideal but not too bad

@jackfoxy
Copy link
Collaborator Author

Now it's coming back to me #279 is a PR on gh-pages. Working on src/docs.

@jackfoxy
Copy link
Collaborator Author

@pblasucci this PR is ready. gh-pages PR #279 also ready. (Maybe don't need a separate PR?) I added tips on migrating an existing project to README.md. @dsyme src/docs caused problems in init.fsx, so I renamed the docsraw folder docsrc.

@pblasucci pblasucci merged commit 1e3f381 into fsprojects:master Jun 12, 2017
@jackfoxy jackfoxy deleted the newdoc branch June 13, 2017 15:15
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.

6 participants