md files in github wiki aren't markdown?

[Ian]

I was going to attempt to update HowToBuildZapWithIntellij.md, but discovered that it contains html instead of markdown encoding.  Is it okay if I make a replacement document that contains markdown?  That seems to be the only document that contains html in the wiki repo.

[thc...@gmail.com]

It's fine to use just markdown.

Note that the wiki pages are no longer editable by anyone with a GitHub
account, you would have to send us a patch with the changes. Also, that
page will be outdated again with the upcoming changes to zaproxy repo
(at least the part for zaproxy, main reason that and other pages were
not updated yet).

Best regards.

[Ian]

I don't mind-re-editing when the changes happen.  I was going to fork, create a new branch and then send a PR with the changes.  If that's a no-go, do you have any suggestions on where I could create this document within your various repos?

[thc...@gmail.com]

Unfortunately the wiki repos can't be forked (so no pull requests either).

The easiest (IMO) is to do the changes locally, commit, and create a
patch. [1]
We can then apply and push.


[1] https://git-scm.com/docs/git-format-patch

Best regards.

[Kevin W. Wall]

Just curious. That must be a ZAP decision, because I did a fork and PR of ESAPI's GitHub wiki and merged it just fine. You just have to fork it from a different URL. So did the ZAP team just decide to disallow it for some reason? I mean, it's not like you are required to accept PRs.

-kevin
--
Blog: http://off-the-wall-security.blogspot.com/  |  Twitter:  @KevinWWall
NSA: All your crypto bit are belong to us.

--
You received this message because you are subscribed to the Google Groups "OWASP ZAP Developer Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to zaproxy-devel...@googlegroups.com.
To view this discussion on the web, visit https://groups.google.com/d/msgid/zaproxy-develop/3fe6086c-2bd7-96f4-fb12-c374815724c9%40gmail.com.
For more options, visit https://groups.google.com/d/optout.

[thc...@gmail.com]

That's news to me, the GitHub site does not show a fork button for wikis
and docs don't mention a fork functionality.

Could you provide the links to the fork and PR you did?

Thank you.
Best regards.

[kingthorin+owaspzap]

I believe this is the current closest solution for wiki PRs: https://www.growingwiththeweb.com/2016/07/enabling-pull-requests-on-github-wikis.html

[Kevin W. Wall]

Ha. Looks like you figured it out. I was trying to find something like that because I couldn't remember all the steps I did.  I ran across similar links after I more or less reinvented it by trial and error after figuring out more or less what what GitHub's fork did and reading lots of Stack Overflow questions.  I was trying to remember how I did it because I blow away my personal GitHub wiki repos when I am done with them to keep down the clutter. And I've been so busy just trying to get our ESAPI release up on Maven Central that this wasn't all that important and so it just popped off the top of my stack and I forgot about it and it was gone from my bash history so good that you found this.

And if GitHub itself wasn't so picky about not allowing a repo to end with '.wiki', then you wouldn't even have to just through as many hoops. That's a GitHub restriction, not a 'git' restriction.

However, I think I cloned it directly into the '-wiki' instead of doing the clone followed by a 'mv' to rename it. E.g, that line you referenced suggests:

# Clone the original wiki
git clone https://github.com/Tyriar/wiki-sync-example.wiki.git

# Rename the folder as it's going to be pushed to the -wiki repository
mv wiki-sync-example.wiki wiki-sync-example-wiki

But you can combine those into:

# Clone the wiki and rename it as '-wiki'.

git clone https://github.com/Tyriar/wiki-sync-example.wiki.git wiki-sync-example-wiki

Also, instead of all the Travis stuff, I ended up just pulling my own "forked" version down to my local laptop and then pushed it back to the upstream github.com/ESAPI/esapi-java-legacy.wiki.git URL.

And you really don't have to these two steps:

# Remove the original wiki repository as the origin
git remote remove origin

# Add the new wiki repository as the origin
git remote add origin https://github.com/Tyriar/wiki-sync-example-wiki.git

Instead, you I think you should just 'push' directly to it instead of using 'origin'; e.g.,

$ git push -u https://github.com/Tyriar/wiki-sync-example-wiki.git master

Lastly, I didn't see where that link tells you that you have to first create a (in this case) 'wiki-sync-example-wiki' repo under your personal area (e.g., github.com/kwwall/wiki-sync-example-wiki for me), otherwise the eventual 'push' will fail because it won't be able to find a repository to push it to.

You don't get any of the bells and whistles that GitHub gives you like being able to merge it via GitHub and (worse, IMO) there is no GitHub issues for the associated wikis, so while you can use your main ZAP issues to track them, referencing the GitHub issue via "issue #issueNumber" (e.g., #123) is not going to link it to your issue. And commit comments like "Close issue #123" will not work either. But it works in a pinch. Since you also will not get a GitHub indication that there is a PR waiting, whomever does the PR needs to email whomever is going to do the merge and push it upstream.

I had been planning to write documentation on this for ESAPI, but waited too long and all those commands were long gone from m bash history and I was going to have to re-research it, so this helped me too. (Or maybe I'll just wait for the ZAP team to document it and then borrow it from you! :)

-kevin

On Fri, May 3, 2019 at 9:27 PM kingthorin+owaspzap <kingt...@gmail.com> wrote:

I believe this is the current closest solution for wiki PRs: https://www.growingwiththeweb.com/2016/07/enabling-pull-requests-on-github-wikis.html

--
You received this message because you are subscribed to the Google Groups "OWASP ZAP Developer Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to zaproxy-devel...@googlegroups.com.

To view this discussion on the web, visit https://groups.google.com/d/msgid/zaproxy-develop/6c421097-7d63-48e3-a1cf-170397892a05%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.