Offical Website about factory-muffin HOT 97 CLOSED

Once we decide on and implement #66 I shall do it.

from factory-muffin.

Why can't we just use Jekyll :( all this coping folders around and stuff is awful.

from factory-muffin.

Also, Sculpin does not work. When i generate, all of the *.html files are totally empty.

from factory-muffin.

It sounds to me like you are doing it wrong. Hop on IRC sometime and lets see if you can get some help from @reinink.

It's a nice smooth process as far as I'm concerned. :)

from factory-muffin.

Regarding my first message, its to do with https://github.com/thephpleague/thephpleague.github.com/tree/project-website-theme#how-to-publish (awful)

Second part, I am just running sculpin generate and all the files are there, but empty.

from factory-muffin.

That is literally one piece of setup with a bit of advice on a good way to do things. Sculpin is basically missing a rake deploy equivalent and you need to do that yourself, but of course as we are smart budding developers we can do that sort of thing ourselves.

https://github.com/thephpleague/fractal/blob/sculpin/deploy.sh

Identical to rake deploy. I just enter my github credentials after its built and the job is done. 

Copy that, tweak it as you need and I’ll update the how to page.

from factory-muffin.

Ok, thanks.

I just prefer being able to just push 'gh-pages' repo and it just builds it all it's self haha.

from factory-muffin.

I can appreciate that the publishing process feels a little painful. What you see in those instructions is the simplest possible instructions I could come up with, other than actually creating a deploy script as Phil is suggesting. We decided to use Sculpin because, 1. it's a PHP project, and 2. it supports themes.

from factory-muffin.

Also, Sculpin does not work. When i generate, all of the *.html files are totally empty.

That clearly is not right. I wonder if there have potentially been some updates to Sculpin that are breaking things. I'm going to have to do some testing to confirm.

from factory-muffin.

I can appreciate that the publishing process feels a little painful. What you see in those instructions is the simplest possible instructions I could come up with, other than actually creating a deploy script as Phil is suggesting. We decided to use Sculpin because, 1. it's a PHP project, and 2. it supports themes.

Makes total sense

That clearly is not right. I wonder if there have potentially been some updates to Sculpin that are breaking things. I'm going to have to do some testing to confirm.

Thank you. I shall try remove and install it all again when i get home. I was going to try a different php version etc too just to make sure.

from factory-muffin.

Okay, so I was able to reproduce the blank pages when I did not run sculpin install prior to starting the server (sculpin generate --watch --server). Can you confirm that you've run this?

You can tell if sculpin install has been run if there is a .sculpin folder. There will also be a /source/themes/ folder created.

from factory-muffin.

I've generated some api docs here: http://muffin.grahamjcampbell.co.uk/.
I've included the faker library in the generation. Also, I've excluded all the tests.

What do you guys think? Also, sami isn't generating the @method docs correctly? Can anybody confirm that the static @method docs work for them in their ide?

from factory-muffin.

Can you confirm that you've run this?

@reinink I did yeah. I shall check if folder exists when I get back home.

I've included the faker library in the generation. Also, I've excluded all the tests.

@GrahamCampbell I am not sure we need to include their stuff do we?

from factory-muffin.

We don't have to, no. I can remove it if you like?

from factory-muffin.

That is totally up to you :) it was just my opinion.

from factory-muffin.

I'll ditch them. It's way faster to generate without them. :)

from factory-muffin.

http://muffin.grahamjcampbell.co.uk/

You might need to hit crtl + f5 to see the changes.

from factory-muffin.

What do you want to do about these api docs?

from factory-muffin.

I could have a go sometime, but I am not going to have time tonight/tomorrow.

from factory-muffin.

I was asking about the "api docs". As in, those auto-generated ones.

from factory-muffin.

Do we want to make the offical, maybe change the url?

from factory-muffin.

Ohh right ok. I'm not sure what we should do with them. Not sure what the process around hosting them is etc.

from factory-muffin.

Well, we could use github pages, or just leave them on my droplet. I can't imagine them using much resources.

from factory-muffin.

Not sure how we could use github pages, as gh-pages branch will be used by the docs

from factory-muffin.

We could make a new repo anywhere. Github pages allows custom urls.

from factory-muffin.

See #193. This stuff can easily be added to a website too.

//cc @philsturgeon, @scottrobertson

from factory-muffin.

Ping @scottrobertson. Have you made any progress with the website? Are we still good for a release on Thursday, or do you need some more time?

from factory-muffin.

@GrahamCampbell sadly not no. I have had literally no time at all sorry.

from factory-muffin.

Don't worry about it. We can always just make the gh-pages branch the api docs for now? Shall I make that change?

from factory-muffin.

Naa, there is not really much point. The README is pretty awesome right now, just need to find some time to move it to the actual site.

from factory-muffin.

But we need a website before we launch like the other league repos. Also, I don't think we should "move" the documentation over there - just duplicate it, like the flysystem repo does.

from factory-muffin.

Having API docs is nothing like the other websites though. I just don't see much point as it won't help the average user learn anything they can't learn from looking at the code.

It's up to you though, I am willing to do whatever. Apologies for not having time though.

@philsturgeon what do you think?

from factory-muffin.

I'm not saying we need api docs, i'm saying we need a website. I was suggesting dumping those on there is a quick fix for now.

from factory-muffin.

We only need a website to serve a purpose though don't we? Having a placeholder for the sake of having a website seems pointless to me when the README does a better job.

from factory-muffin.

I shall try and find some time tonight :)

from factory-muffin.

TBH, I don't really like the idea of having a website anyway. I'm only pushing it because I think we have to as a php league repo. What's the reality of this @philsturgeon?

from factory-muffin.

Yeah, I am kinda the same.

It does make sense to have it there for documentation and stuff, but I am not sure it should be a blocker for v2

from factory-muffin.

I'm not sure it even makes sense to have it anyway. For example, if you look at flysystem's - all that's happened is it has become outdated because it's a pain in the ass to update. It'd prefer just to maintain our readme and upgrading guide as they are now.

from factory-muffin.

It's not a requirement and it's not a blocker for v2. Get v2 out then try and get a website done at some point if you want.

---Sent from Boxer | http://getboxer.com

On 5 August 2014 16:17:45 GMT-4, Graham Campbell [email protected] wrote:TBH, I don't really like the idea of having a website anyway. I'm only pushing it because I think we have to as a php league repo. What's the reality of this @philsturgeon? —Reply to this email directly or view it on GitHub.

from factory-muffin.

I'll move this to the v2.1.0 milestone for now then.

from factory-muffin.

I've had a play around with https://github.com/justinwalsh/daux.io and it looks pretty easy. I've got our docs working fine in it on my pc. A simple solution would be to use that?

from factory-muffin.

Tell me what you think: http://muffin.grahamjcampbell.co.uk/test/.

from factory-muffin.

Hmm, does daux.io require PHP on the server? From what I have read it does. We would need something that generates static HTML to host on Github Pages.

from factory-muffin.

But they do look good :)

from factory-muffin.

@scottrobertson It is static html. muffin.grahamjcampbell.co.uk is hosted on github pages.

from factory-muffin.

The generated html is here: https://github.com/GrahamCampbell/factory-muffin-api-docs/tree/gh-pages/test.

from factory-muffin.

@scottrobertson Shall I publish it to this repo's gh-pages then?

from factory-muffin.

@philsturgeon Can we have muffin.thephpleague.com cnamed to this repo's gh-pages?

from factory-muffin.

Ohh really? I read on their docs that it needed a PHP server. Maybe that was old docs or something. And yeah, i think it's an awesome start. Not sure how they feel about not using Sculpin though.

from factory-muffin.

I'll wait for @philsturgeon to reply before I do anything.

from factory-muffin.

You could just do it, can always just revert :) i think it looks awesome though.

from factory-muffin.

Yeh, but we need the cname setting up.

from factory-muffin.

I'll put it up onto gh-pages in a few mins.

from factory-muffin.

:) thanks

from factory-muffin.

Hmm, well for now, this works: http://thephpleague.com/factory-muffin/.

We just don't have a subdomain yet.

from factory-muffin.

Hi gents, just back from holidays and following up on this. I'm personally not a fan of having different style documentation sites for different League packages. The idea was to create consistency between our projects, both from a branding perspective, but also so that dev's familiar with the League will know what to expect. I'd encourage you to get an actual League site up eventually, although there is clearly no major urgency to it.

from factory-muffin.

That's fine. Also, Factory Muffin is missing from the package lists on the other league websites and the main site.

from factory-muffin.

@GrahamCampbell I am happy with your one being the site for now though. I shall do the site when i get an hour or so to sit down and have a go.

from factory-muffin.

That's fine. Also, Factory Muffin is missing from the package lists on the other league websites and the main site.

Simply add it to this file: https://github.com/thephpleague/thephpleague.github.com/blob/master/_data/packages.yml

from factory-muffin.

Yeh, but we have 2 authors. How does that work?

from factory-muffin.

We could get married and use Mr and Mr? That seems like a reasonable solution to me.

from factory-muffin.

Lol. We have two different user names on github though.

from factory-muffin.

Good point. Can you just put one for now? Will have to rethink how that works.

from factory-muffin.

Better put Scott down. He's been here the longest. :)

from factory-muffin.

@reinink you have to decide who you like the most :P

from factory-muffin.

HAHA, that's not MY call! :)

Who originally started it?

from factory-muffin.

@GrahamCampbell To be fair, neither of us started this originally. I mean, it's not the same code anymore at all, but still.

from factory-muffin.

@Zizaco originally started it, so many we should put his name? Not sure how much he wants to be involved in this anymore though.

from factory-muffin.

It's meant to show the project lead, not who originally created it. So either of you is fine at this point if you're both leading it.

from factory-muffin.

@GrahamCampbell you decide.

from factory-muffin.

Hmmm. It's not really Zizaco's project now though. Just put Scott down. He's been here longer than I have. We can add me once you work out how to do it. :)

from factory-muffin.

Sounds good. Also, one of the goals with the League is to make it about the packages more than the people. The only reason we show a project lead is for the purpose of giving a contact—not for credit purposes. From our website:

WE’RE ALL ABOUT PACKAGES

This group is about packages, and not about the people. To keep that clear - and to make sure people are joining for the right reasons - no members list will be posted, but we’ll let you know who is in charge of packages so you can poke them with feedback.

from factory-muffin.

Yeah i was going to say that, do we NEED an author? Can we not make it optional?

from factory-muffin.

I think for consistency it would be nice to have. As in, I wouldn't remove it just because there are two project leads.

from factory-muffin.

Can you just write something. It's not worth the discussion, as long as the package is added.

from factory-muffin.

@GrahamCampbell I think we need to submit a PR

from factory-muffin.

@scottrobertson Yep, if you need me to do it let me know.

from factory-muffin.

@reinink That might be easier if you could.

from factory-muffin.

On it.

from factory-muffin.

Thank you @reinink

from factory-muffin.

It seems to be working now: http://factory-muffin.thephpleague.com/. I've put the api docs on there too.

from factory-muffin.

@scottrobertson If you don't have time, I can sort the sculpin website tomorrow.

from factory-muffin.

I'm working on this now.

from factory-muffin.

Thanks. Sorry i missed your comment last night.

from factory-muffin.

Done: http://factory-muffin.thephpleague.com/. You may need to ctrl+f5 to see the new site or whatever.

from factory-muffin.

Awesome, thank you @GrahamCampbell

from factory-muffin.

@reinink Sculpin isn't rendering bullet points correctly:
http://factory-muffin.thephpleague.com/usage/more/

from factory-muffin.

@GrahamCampbell You just needed an extra line return. I've added this, but you still need to republish.

from factory-muffin.

Ok. There are probably a few other occurrences I'll need to find. I'll republish the site later today. There are a few other things I need to fix.

from factory-muffin.

Thanks @reinink

from factory-muffin.

Happy to help gents. I've also added Google Analytics and fixed your permalinks.

from factory-muffin.

Thanks. Also, how do we access the analytic data? Can it be read-only shared with our google accounts?

from factory-muffin.

For sure, just provide me with your Google account email address.

from factory-muffin.

I'll email them to you...

from factory-muffin.

Mine is added :)

from factory-muffin.

I've just regenerated the website now.

from factory-muffin.

awesome, looks good :D

from factory-muffin.