[
https://bro-tracker.atlassian.net/browse/BIT-1413?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=20913#comment-20913
]
Jon Siwek commented on BIT-1413:
--------------------------------
Probably doesn't matter much which way to it's done, but I remember going with
the symlink README.rst -> README in pysubnettree after a user complained about
the github formatting there.
For the question about deleting the bromagic repo, unfortunately I think it's
better to have it stick around -- there are some commits in Bro that refer to
it as a submodule, so if bromagic just goes away they will point to nothing and
that part of Bro's git history becomes broken (and I don't recall if a release
version of Bro ever used bromagic, but that could make deleting it a bigger
deal if so).
> README files misidentified by GitHub
> ------------------------------------
>
> Key: BIT-1413
> URL: https://bro-tracker.atlassian.net/browse/BIT-1413
> Project: Bro Issue Tracker
> Issue Type: Problem
> Components: Documentation
> Reporter: Vlad Grigorescu
>
> If a README file doesn't have an extension, GitHub will parse it as Markdown.
> Because our README files are ReST, this results in some ugly (and not very
> useful) READMEs when visiting the repository on GitHub.
> For example, see: https://github.com/bro/btest#readme
> There are two options we could take to fix this: rename README to README.rst,
> or create a symlink. I tried out the symlink option here, and I think the
> result is much more useful: https://github.com/grigorescu/btest#readme
> The affected repos are:
> binpac
> bro
> bro-aux
> bro-plugins
> bro-scripts
> broccoli
> broccoli-perl
> broccoli-python
> broccoli-ruby
> broctl (broctl's README just instructs users to see doc/broctl.rst. This
> could just be a symlink)
> broker
> bromagic (this can probably be deleted?)
> btest
> capstats
> time-machine
> trace-summary
--
This message was sent by Atlassian JIRA
(v6.5-OD-05-041#65001)
_______________________________________________
bro-dev mailing list
bro-dev@bro.org
http://mailman.icsi.berkeley.edu/mailman/listinfo/bro-dev
