Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Thesilence docs #393

Merged
merged 24 commits into from
Aug 11, 2017
Merged

Thesilence docs #393

merged 24 commits into from
Aug 11, 2017

Conversation

therealsilence
Copy link
Contributor

Additional User Guide documentation on:

  • Tag Concepts
  • Tag Analytical Model
  • Synapse Commands
  • Storm Background

@codecov
Copy link

codecov bot commented Aug 10, 2017

Codecov Report

Merging #393 into master will increase coverage by 0.25%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #393      +/-   ##
==========================================
+ Coverage   90.41%   90.67%   +0.25%     
==========================================
  Files         127      127              
  Lines       14279    14537     +258     
==========================================
+ Hits        12910    13181     +271     
+ Misses       1369     1356      -13
Impacted Files Coverage Δ
synapse/daemon.py 83.61% <0%> (+0.21%) ⬆️
synapse/datamodel.py 97.87% <0%> (+0.3%) ⬆️
synapse/links/ssl.py 87.5% <0%> (+0.78%) ⬆️
synapse/cores/common.py 93.93% <0%> (+1.13%) ⬆️
synapse/lib/threads.py 68.62% <0%> (+1.47%) ⬆️
synapse/lib/socket.py 85.55% <0%> (+1.69%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2a2c4d1...b74e75d. Read the comment docs.


Alternately, they can be highly complex, chaining a series of operators to lift a set of nodes and perform a series of additional filter and pivot operations that follow a line of analysis across the data:

``cli> ask inet:fqdn*tag=tc.t12 -> inet:dns:a:fqdn inet:dns:a:ipv4 -> inet:ipv4 -#anon.tor -#anon.vpn -> inet:dns:a:ipv4 inet:dns:a:fqdn -> inet:fqdn``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line goes off the page for me, but I am not sure how to fix it. It might be possible to use "code blocks": https://rest-sphinx-memo.readthedocs.io/en/latest/ReST.html#code-blocks

vertexmc
vertexmc previously approved these changes Aug 11, 2017
Copy link
Contributor

@vertexmc vertexmc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These docs looks great! I only found one issue (made another comment) around line breaks.

vertexmc
vertexmc previously approved these changes Aug 11, 2017
Copy link
Contributor

@vertexmc vertexmc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks better. I noticed in section 11 that the strings seem to wrap when enclosed in ()s.

Ex: (inet:dns:a:fqdn -> inet:fqdn)

Fix typo (fqdd -> fqdn)
Copy link
Contributor

@vEpiphyte vEpiphyte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shipit

@vEpiphyte vEpiphyte merged commit 7a065ec into master Aug 11, 2017
@vertexmc vertexmc modified the milestone: v0.0.21 Aug 11, 2017
@vertexmc vertexmc deleted the thesilence_docs branch August 11, 2017 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants