Re: Suggestion: reformat docs to Markdown and alias git.nmap.org?

[Daniel Miller <bonsaiviking () gmail com>]

On Wed, Jan 27, 2016 at 11:28 AM, Jacek Wielemborek <d33tah () gmail com>
wrote:

> List,
>
> I was just experimenting with an update to my response in "Newbie
> contributer to NMAP" thread [1], with an intent to put in on secwiki. I
> realized that on this mailing list we're getting into the habit of
> pointing people to Github version of Nmap source code instead of
> svn.nmap.org (which makes sense, because this way we're getting syntax
> highlighting).
>
> I was thinking of pointing to a Github version of todo.txt and had this
> thought that it would be nice to have those in a Markdown version. It
> wouldn't really be a lot of effort (basically use "-" instead of "o" for
> list bullets) or make it less readable (just use .md instead of .txt,
> which might annoy Windows users anyway, but how many hackers can't
> really use "open with" feature?). Actually, we could consider doing that
> to the rest of the docs. In addition to that, maybe it would make sense
> to rename HACKING.txt to README.md?

Instead of linking to the todo file, link to the issue tracker. The todo
file is useful as an archive of old todo tasks, but we should be using the
issue tracker instead for most things.

Most of our documentation doesn't require the kind of markup that Github
offers. A README.md file would be useful, but I wouldn't consider the
HACKING file to be the kind of info that should be in there. I would think
it should contain a simple, short summary of the Nmap project and pointers
to the various documentation sources (HACKING, CONTRIBUTING.md,
nmap.org/book, docs directory).


> Also, perhaps it would make sense to set up git.nmap.org as an alias to
> gitub.com and route people through this URL? I'm not sure if it would
> work, but if it did, we'd keep control of the source domain for the
> future reference.
We have a redirector at http://issues.nmap.org/ that is described in the
CONTRIBUTING.md file.


> BTW, I recently checked out Gitlab and if there's any chance that Nmap
> is still looking for a reasonable self-hosted Git system, this one might
> actually be perfect. It's basically an open source clone of Github that
> is trivial to set up. Definitely worth looking at.
Thanks for the suggestion.

Dan

_______________________________________________
Sent through the dev mailing list
https://nmap.org/mailman/listinfo/dev
Archived at http://seclists.org/nmap-dev/