[Bro-Dev] [JIRA] (BIT-1413) README files misidentified by GitHub

Johanna Amann (JIRA) jira at bro-tracker.atlassian.net
Mon Jan 11 13:15:00 PST 2016


     [ https://bro-tracker.atlassian.net/browse/BIT-1413?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Johanna Amann reassigned BIT-1413:
----------------------------------

    Assignee: Johanna Amann  (was: Jeannette Dopheide)

> 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
>            Assignee: Johanna Amann
>            Priority: Low
>             Fix For: 2.5
>
>
> 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
(v7.1.0-OD-04-012#71001)


More information about the bro-dev mailing list