search

fsprojects / ProjectScaffold

A prototypical .NET solution (file system layout and tooling), recommended for F# projects
http://fsprojects.github.io/ProjectScaffold
The Unlicense
516 stars 153 forks source link

docs as GitHub Pages source folder #278

Closed jackfoxy closed 7 years ago

jackfoxy commented 7 years ago

simpler model to publish project gh pages

jackfoxy commented 7 years ago

This PR related to issue https://github.com/fsprojects/ProjectScaffold/issues/201#issuecomment-258626595 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 commented 7 years ago

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

pblasucci commented 7 years ago

@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 commented 7 years ago

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

jackfoxy commented 7 years ago

@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 commented 7 years ago

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 commented 7 years ago

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 commented 7 years ago

:+1: 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 commented 7 years ago

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

jackfoxy commented 7 years ago

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

jackfoxy commented 7 years ago

@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.