jc7447 / BetterDynAdmin

Refreshing ATG Dyn Admin
GNU General Public License v2.0
38 stars 11 forks source link

Wiki Pull Request trick #129

Open sixdouglas opened 6 years ago

sixdouglas commented 6 years ago

Hi,

I'd like to use the hacktoberfest to improve BDA documentation.

Here is a very interesting way to let people update the wiki using a Pull Request and Github CI mecanism.

http://www.growingwiththeweb.com/2016/07/enabling-pull-requests-on-github-wikis.html

Thanks ;)

troussej commented 6 years ago

good idea!

sixdouglas commented 6 years ago

@jc7447 can you create the new repository to keep the same ownership?

This way I'll be able to start adding the new files.

jc7447 commented 6 years ago

It looks good but I will be time short this week-end and next week (vacation :relaxed: ) I will create the repo "BetterDynAdmin-wiki-sync" and give you the admin right on both repo so you can setup eveyhting

jc7447 commented 6 years ago

Here you go : https://github.com/jc7447/BetterDynAdmin-wiki Brand new :)

sixdouglas commented 6 years ago

Thanks But as I'm not the real owner of this repository, I can't setup Travis CI... :disappointed:

jc7447 commented 6 years ago

Voilà ! https://github.com/jc7447/BetterDynAdmin/wiki Seems to work pretty nice. I just notice that some links of the home page end up in a page with raw asciidoc

sixdouglas commented 6 years ago

Hello Great news! In deed, looks good to me. Images appears correctly. I’ve added a black line around the images to see them correctly, what do you think of it? At the top of each pages in the raw file there is a macro that sets the extension of the files for the links. Maybe if we set this only if the git-hub env variable doesn’t exists it will work as expected. I’ll try to push it later this day. Cheers

jc7447 commented 6 years ago

It looks good with the black border. Also the README file of the wiki repo which contains the build status appears in the wiki menu, may be there is a way to hide it

sixdouglas commented 6 years ago

Hello I found a trick for the links on the Homepage. Using this in the file header: ifndef::env-github[] :ext-relative: {outfilesuffix} endif::[] ifdef::env-github[] :ext-relative: endif::[]

And then creating link like this: link:General{ext-relative}[General Features]

For the Readme maybe you can push a .ignore file on the git wiki repo to ignore it. But I don't know if Travis will merge the file correctly. Another possibility would be to remove it from the BetterDynAdmin-wiki repo.

sixdouglas commented 6 years ago

Another possibility: There is a _Footer.md file on the BetterDynAdmin-wiki repository that doesn't appear on the BetterDynAdmin/wiki maybe you can rename the Readme.md to _Readme.md. It may still work as Readme.md for the BetterDynAdmin-wiki repository