Offical Website

[philsturgeon]

Who wants the job of making the documentation for the website?

Instructions here

[scottrobertson]

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

[scottrobertson]

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

[scottrobertson]

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

[philsturgeon]

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. :)

[scottrobertson]

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.

[philsturgeon]

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.

[scottrobertson]

Ok, thanks.

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

[reinink]

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.

[reinink]

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.

[scottrobertson]

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.

[reinink]

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.

[GrahamCampbell]

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?

[scottrobertson]

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?

[GrahamCampbell]

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

[scottrobertson]

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

[GrahamCampbell]

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

[GrahamCampbell]

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

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

[GrahamCampbell]

What do you want to do about these api docs?

[scottrobertson]

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

[GrahamCampbell]

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

[GrahamCampbell]

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

[scottrobertson]

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

[GrahamCampbell]

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

[scottrobertson]

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

[GrahamCampbell]

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

[scottrobertson]

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

[reinink]

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

[GrahamCampbell]

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

[scottrobertson]

@GrahamCampbell I think we need to submit a PR

[reinink]

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

[GrahamCampbell]

@reinink That might be easier if you could.

[reinink]

On it.

[scottrobertson]

Thank you @reinink

[GrahamCampbell]

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

[GrahamCampbell]

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

[GrahamCampbell]

I'm working on this now.

[scottrobertson]

Thanks. Sorry i missed your comment last night.

[GrahamCampbell]

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

[scottrobertson]

Awesome, thank you @GrahamCampbell

[GrahamCampbell]

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

[reinink]

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

[GrahamCampbell]

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.

[scottrobertson]

Thanks @reinink

[reinink]

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

[GrahamCampbell]

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

[reinink]

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

[GrahamCampbell]

I'll email them to you...

[scottrobertson]

Mine is added :)

[GrahamCampbell]

I've just regenerated the website now.

[scottrobertson]

awesome, looks good :D