search

diffpy / diffpy.github.io

web hosting for www.diffpy.org
2 stars 12 forks source link

DOC/WIP: add to diffpy website #17

Closed CJ-Wright closed 6 years ago

pavoljuhas commented 6 years ago

@CJ-Wright, @chiahaoliu - this seems at a very early WIP stage. Please test in a gh-pages branch of your forked repos. These get published at http://USER.github.io/diffpy.github.io.

Here is how to setup the repo so that compiled webpage publishes to your gh-pages:

One time setup

git clone -b source https://github.com/diffpy/diffpy.github.io.git
cd diffpy.github.io
git remote add cj https://github.com/CJ-Wright/diffpy.github.io.git
# 'origin/master' is the current diffpy.org
# your version will publish via 'gh-pages' branch
git branch gh-pages origin/master
git push -u cj gh-pages:gh-pages

Create GNUmakefile file with the following content:

include Makefile
PUBLISHBRANCH = gh-pages

Work on the mappdf branch and publish it to gh-pages:

make html
make publish-prepare
## optional - review changes to be published
# git show --word-diff gh-pages
make publish-push
CJ-Wright commented 6 years ago

I am just running a local http server and making the build. That way I can look at the pages locally. Is there a problem with this PR specifically? I know it's not ready to go in yet but I didn't think it was harming anything, right?

pavoljuhas commented 6 years ago

Local web server is a good trick. The PR does not harm anything, but is a bit confusing. I usually submit PR-s when ready to go, before then I keep the work non-advertised.

CJ-Wright commented 6 years ago

I usually like to put things up as early as possible so that others can comment on the general direction before I sink too much work into something that no one wants.

pavoljuhas commented 6 years ago

So is it decided if mappdf needs a page at diffpy.org or not? cc: @sbillinge

It may be better to discuss what to do and what not at the bg-dev mailing list. From my POV this looked like something you really wanted to merge.

BTW, the mappdf package does not seem ready - no setup.py, no README, and a few other issues I commented on today. Please, have the package ready before making a PR to add it to diffpy.org.

sbillinge commented 6 years ago

Yes, we want to link to it from diffpy.org so it needs to be to similar standards. Naming consistently makes sense to me (so diffpy.mapPDF). On Fri, Dec 1, 2017 at 3:20 PM Pavol Juhas notifications@github.com wrote:

So is it decided if mappdf needs a page at diffpy.org or not? cc: @sbillinge https://github.com/sbillinge

It may be better to discuss what to do and what not at the bg-dev mailing list. From my POV this looked like something you really wanted to merge.

BTW, the mappdf package does not seem ready - no setup.py, no README, and a few other issues I commented on today. Please, have the package ready before making a PR to add it to diffpy.org.

— You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub https://github.com/diffpy/diffpy.github.io/pull/17#issuecomment-348604478, or mute the thread https://github.com/notifications/unsubscribe-auth/AEDrUZaIkKeuTI03x2eM1zcbK82oZ4Ieks5s8F-DgaJpZM4QygGp .

pavoljuhas commented 6 years ago

Closing - this PR is not even started. I understand PRs as what their name states - a request to pull. I'd be glad to help with an early work, but PR with no description is not a way to do so. Please post an email to bg-dev or create an issue and describe what you are trying to do and what the questions are (if applicable, include a URL to your WIP branch).

pavoljuhas commented 6 years ago

Naming consistently makes sense to me (so diffpy.mapPDF).

I'd suggest to use lowercase diffpy.mappdf. Python PEP 8 recommends lowercase module and package names. It is better if repository and package names were the same.