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

Update Synapse automation user guide and other docs #2917

Merged
merged 10 commits into from
Nov 17, 2022

Conversation

therealsilence
Copy link
Contributor

  • Synapse User Guide for Automation:
    • Correct description of trigger behavior on merge
    • Expand on trigger / cron behavior regarding views and forks
    • Expand discussion of permissions for triggers / cron / macros
    • Add line breaks for easier (internal) review
    • General revision / overhaul of doc
  • Synapse Intro page:
    • Remove reference to obsolete feature
    • Update links to external resources
  • Synapse Glossary:
    • Add entries for Optic Tools (so they can be ref'ed from Synapse docs)
    • Revise entries for Optic and Power-Ups to clarify they are commercial

@codecov
Copy link

codecov bot commented Nov 14, 2022

Codecov Report

Base: 97.16% // Head: 97.06% // Decreases project coverage by -0.10% ⚠️

Coverage data is based on head (2824681) compared to base (f67bcf6).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2917      +/-   ##
==========================================
- Coverage   97.16%   97.06%   -0.11%     
==========================================
  Files         215      215              
  Lines       42095    42080      -15     
==========================================
- Hits        40903    40844      -59     
- Misses       1192     1236      +44     
Flag Coverage Δ
linux 97.06% <ø> (-0.01%) ⬇️
linux_replay ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
synapse/tests/utils.py 94.46% <0.00%> (-1.89%) ⬇️
synapse/cortex.py 96.50% <0.00%> (-0.57%) ⬇️
synapse/lib/hiveauth.py 96.01% <0.00%> (-0.48%) ⬇️
synapse/lib/trigger.py 95.01% <0.00%> (-0.39%) ⬇️
synapse/lib/view.py 97.00% <0.00%> (-0.34%) ⬇️
synapse/cmds/cron.py 97.56% <0.00%> (-0.25%) ⬇️
synapse/lib/jsonstor.py 98.32% <0.00%> (-0.24%) ⬇️
synapse/axon.py 98.73% <0.00%> (-0.15%) ⬇️
synapse/lib/layer.py 96.99% <0.00%> (-0.05%) ⬇️
synapse/lib/chop.py 98.00% <0.00%> (-0.04%) ⬇️
... and 9 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@vEpiphyte vEpiphyte added this to the v2.11x.x milestone Nov 14, 2022
docs/synapse/intro.rst Outdated Show resolved Hide resolved
mbvertex
mbvertex previously approved these changes Nov 14, 2022
@therealsilence therealsilence removed the request for review from vEpiphyte November 17, 2022 00:18
@therealsilence therealsilence merged commit 52e33e1 into master Nov 17, 2022
@therealsilence therealsilence deleted the thesilence_docs_automation branch November 17, 2022 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants