This morning I dug around on the website, github repo, and wiki to get
answers to what are some pretty standard FAQ-style questions.  I've noticed
a few broken links along the way (On here
<https://cwiki.apache.org/confluence/display/METRON/Sensors>, this link
<https://github.com/apache/incubator-metron/tree/master/bro-plugin-kafka>
should be this
<https://github.com/apache/incubator-metron/tree/master/metron-sensors/bro-plugin-kafka>),
and also the fact that documentation sometimes exists in different places
depending on what you're looking at (For instance, in both README.mds
<README.mdshttps://github.com/apache/incubator-metron/blob/master/metron-streaming/Metron-EnrichmentAdapters/README.md>
 and wiki <https://cwiki.apache.org/confluence/display/METRON/Enrichments>
articles
<https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=62685647>,
etc.).

I have two questions:
1.  Is there/should there be a standard location or method for how to
document, and where documentation exists?
2.  How can a user like me make sure they're looking in the right locations
for documentation, and when they find issues, submit the equivalent of a PR
to update it across the board (including on the cwiki).

Thanks,

Jon
-- 

Jon

Reply via email to