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

[Johanna Amann (JIRA)]

    [ https://bro-tracker.atlassian.net/browse/BIT-1413?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=23833#comment-23833 ] 

Johanna Amann commented on BIT-1413:
------------------------------------

After playing around for a bit - it is basically impossible to create something here that works in sphinx and in github (the links end up broken in one of the two cases).

The current solution is to change the phrasing somewhat, so it does not look odd when the links are not present on GitHub and leave everything else as is.

Besides this, everything in this ticket is done. Closing.

> 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)