pretzel
pretzel copied to clipboard
Code52
Use Pretzel and Github Pages for Pretzels own doc's.
It would be cool if we could use GithubPages and pretzel it self to build the documentation. This way it would be possible to contribute to documentation and help without the need of githubs wiki system.
Proposed solutions:
- Single Repo approach
- Configure GithubPages with the master branch and docs folder
- Add a pretzel site to the project under
_docs(or something similar) and output the site todocs. - Add a build step that the pretzel site will be built
The only disadvantage of this is, if we change the documentation, we need to build the site with pretzel and checkin the content's of
docsfolder by hand (or create an automated commit on the current branch on Appveyor, but I don't know if this is possible?)
- Multiple Repo approach
Use a seperate repository like explained by Devon Burriss
But working with
submodulesis so painful...
This will address #141
Nice idea, I wanted to improve the site that is already using github pages on the gh-pages branch but haven't thought of adding the docs.
I agree to move the generated site source to a docs repo instead of having it in another branch.
It is possible to create and push a commit from AppVeyor, I already do something similar for some of my sites.
I agree to move the generated site source to a docs repo instead of having it in another branch.
Do you really want to make a repo? Or did you ment folder?
It is possible to create and push a commit from AppVeyor, I already do something similar for some of my sites.
👍
Do you really want to make a repo? Or did you ment folder?
Folder, sorry. I haven't the rights to create another repo in Code52 so the folder should do it :)
Is github pages enabled? It kinda has to be, cause http://code52.github.io/pretzel redirects to http://code52.org/pretzel/
Of course it is cause there it's https://github.com/Code52/code52.github.com That would conflict with the idea.... Cause i felt in this trap my own cause i had an old GHP repo laying around in my profile
Yep it already is, using the gh-pages branch and the custom domain http://code52.org.
That won't conflict because https://github.com/Code52/code52.github.com handle the main site and th github page on the pretzel repo handles the code52.org/pretzel part.
Well, github use Jekyll to generate the site so this is a good opportunity to check the equivalence with pretzel :) And remove the need to generate the site during the AppVeyor build.
But as far as i tested if there is a organization gh-page it's not possible to use gh-pages for the repositories :/
Well github says that it is possible:
A Project Pages site for an organization account is available at http(s)://<orgname>.github.io/<projectname>.
To be sure, we just have to modified the gh-pages branch in pretzel repo (like adding an html comment) and see if it appears on http://code52.org/pretzel/ :)
I don't even know where this comes from 🤷♂️ I just looked into the repo and can't find a clue where this lives or where this does come from...
I have switched the github pages settings to use the docs folder in master instead of the gh-pages branch.
Does this work on your side?
Is github pages enabled? It kinda has to be, cause http://code52.github.io/pretzel redirects to http://code52.org/pretzel/
seams like it still redirects to the old page?
The url won't change, github page is configured to serve it to http://code52.org/pretzel/ But I can guarantee that it works, I received a mail from github to correct some old markdown parameters :)
Apart if we need to use some specific plugins, since github pages use Jekyll it is a good way to check that we have parity with jekyll (at least for functionalities used by the docs).
That's a good idea, but it will need a thorough followup on each jekyll release.