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

docs: siren docs improvement #138

Merged
merged 2 commits into from
Oct 21, 2022
Merged

docs: siren docs improvement #138

merged 2 commits into from
Oct 21, 2022

Conversation

mabdh
Copy link
Member

@mabdh mabdh commented Oct 18, 2022

This is rebased to PR #136

Changes

  • Update docs
    • Add a glossary section to introduce all key terms.
    • Update concept section to explain all keys terms in details.
    • Update guide flow wth an example journey. Check buf guide for reference.
    • Complete reference to other things should move to references. Check Buf for reference.
    • Update guides to accommodate CLI and API using docusaurus tabs.
    • Create a full CLI reference and move it to reference section.
    • Create a full API reference and move it to reference section.
    • Remove empty pages. Merge monitoring, deployment and troubleshooting in deployment guide only.
  • Refactor and clean up codes
  • Fix inconsistencies

@mabdh mabdh linked an issue Oct 18, 2022 that may be closed by this pull request
8 tasks
@mabdh mabdh changed the title Siren docs improvement docs: siren docs improvement Oct 18, 2022
@mabdh mabdh force-pushed the siren-docs-improvement branch from c014c49 to 16ef39a Compare October 19, 2022 12:46
@coveralls
Copy link

coveralls commented Oct 19, 2022

Pull Request Test Coverage Report for Build 3297789086

  • 79 of 145 (54.48%) changed or added relevant lines in 13 files are covered.
  • 8 unchanged lines in 2 files lost coverage.
  • Overall coverage decreased (-0.2%) to 81.17%

Changes Missing Coverage Covered Lines Changed/Added Lines %
plugins/receivers/httpreceiver/receiver_service.go 3 4 75.0%
plugins/receivers/slack/notification_service.go 5 6 83.33%
plugins/receivers/pagerduty/receiver_service.go 4 6 66.67%
plugins/receivers/slack/receiver_service.go 4 6 66.67%
internal/api/v1beta1/receiver.go 2 6 33.33%
core/receiver/type.go 0 6 0.0%
plugins/receivers/httpreceiver/notification_service.go 3 11 27.27%
plugins/receivers/file/receiver_service.go 13 22 59.09%
plugins/receivers/pagerduty/notification_service.go 3 15 20.0%
plugins/receivers/file/notification_service.go 22 43 51.16%
Files with Coverage Reduction New Missed Lines %
plugins/receivers/httpreceiver/notification_service.go 1 66.67%
plugins/queues/inmemory/queue.go 7 51.85%
Totals Coverage Status
Change from base Build 3297745307: -0.2%
Covered Lines: 2996
Relevant Lines: 3691

💛 - Coveralls

@haveiss haveiss force-pushed the siren-docs-improvement branch from 1f6cf1c to 2570578 Compare October 20, 2022 05:03
@mabdh mabdh force-pushed the siren-docs-improvement branch 3 times, most recently from 89ee97f to 21a0435 Compare October 21, 2022 10:48
@mabdh mabdh marked this pull request as ready for review October 21, 2022 10:49
@mabdh mabdh requested review from rahmatrhd and ravisuhag October 21, 2022 10:49
@mabdh mabdh force-pushed the siren-docs-improvement branch from 21a0435 to 35a43d3 Compare October 21, 2022 13:24
@ravisuhag ravisuhag merged commit 6c7fdf8 into main Oct 21, 2022
@ravisuhag ravisuhag deleted the siren-docs-improvement branch October 21, 2022 13:32
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.

Update Siren Documentation
3 participants