triggermesh / docs Goto Github PK
View Code? Open in Web Editor NEWDocumentation for https://github.com/triggermesh/triggermesh
Home Page: https://docs.triggermesh.io
License: Apache License 2.0
Documentation for https://github.com/triggermesh/triggermesh
Home Page: https://docs.triggermesh.io
License: Apache License 2.0
Add docs for Confluent Target
Add docs for Jira Target
Support for retrieving metrics and logs from CloudWatch has recently been added to the source, but would still need some documented love.
Add information on Bridges
As a user, I would like to see the documentation theming to be the same as the Triggermesh theming.
This will require us to create a css file and add styles to override the default. According to https://www.mkdocs.org/user-guide/styling-your-docs/
Create a template for targets and show example.
Add targets documentation
Currently, the screenshots provided in the documentation are not up-to-date with the current design.
You may need to update directions based on the new screenshots.
Update the sources/targets index to reflect all sources and targets. In addition, break up the single AWS target to reflect the different AWS offerings.
Originally posted by @cab105 in #29
According to MLA, all titles should follow some capitalization rules: https://style.mla.org/capitalization-of-titles/
An example of page using that style: https://style.mla.org/plagiarism-and-academic-dishonesty/
@cab105 mentioned we should stick to that style in doc pages, so we should update existing ones and remember to follow those rules in the future.
parent task: #45
The current getting started guide https://docs.triggermesh.io/guides/gettingstarted/ doesn't have images that match the current interface.
Additionally, The Getting Started Guide should be more explicit then what is currently there. With explanations of sources, bridges, and targets as well as the list of supported services.
Apparently the twilio target now needs a specific event type.
It used to be any type but with a specific paylod: https://docs.triggermesh.io/targets/twilio/#event-types
We need a guide to setup the eventbridge target docs with snapshots from our UI and the AWS UI.
Maybe also a screencast that we can put on youtube
Maybe there should be a rules pages that goes under templates.
Rules:
Use of -
for bullets
Capital letter for TriggerMesh known elements like Bridges, Sources, Targets, use TriggerMesh
and not Triggermesh
.
Use 1. instead of 1. 2. 3. for lists.
Currently there are none
Add OCI Metrics Source documentation and update/verify the Oracle Cloud target
The target docs for confluent, googlesheets, and tekton were originally migrated over from the developer documentation, but could use some love by integrating it more into the UI/frontend.
As a user, I would like to use the search bar to easily find information in the documentation.
Currently, if I type in a term to search the documentation, I see that a "?" appears in the URL, but nothing happens.
https://www.loom.com/share/20886128838a424f8ba5a76c112c1885
May have to read the MKDocs to see if we need to add any logic.
Currently, we have GitLab spelled as Gitlab. Also in the Targets tab, we have Elasticsearch spelled as Elasticsarch
I think this is a good opportunity to go through all of the Services, Targets, etc to make sure that we have all of the company's names spelled correctly and using the correct capitalization.
List of Targets and Services
AWS (Lambda, Kinesis, EventBridge, CodeCommit, SQS, SNS, DynamoDB)
GitHub
GitLab
Datadog
SendGrid
Elasticsearch
Hasura
Oracle
Slack
Splunk
Tekton
Zendesk
Twilio
Azure
OCIMetrics - Oracle Cloud Infrastructure Metrics
Salesforce
Docs for HTTP Target are missing.
macOS Catalina v 10.15.4 using Google Chrome V. 81.0.4044.138
I also tried with another account on Safari V. 13.1
Create a template for sources.
Add the HTTPSource docs
Create Salesforce Target Docs
Add user facing documentation on setting up the target and provide expectation of the event types as requested by #45.
Clean up the target documentation to illustrate how to create the target from the UI, and fix a typo in the Slack source.
There seems to be a nice mkdocs theme with material design:
https://squidfunk.github.io/mkdocs-material/creating-your-site/
It would be interesting to see if this can be used to make our doc website more professional looking.
The knative website is moving to it: https://julz.github.io/docs/dev/
Make sure the source docs follows the new template
The bullet points should be changed from *
to -
As a developer, I would like to see detailed templates/rules for creating issues and pull requests. As a member of the TriggerMesh application, I would also like to see these guidelines in place to make open source contributions easier.
Expected
desc
Currently, if I go to this page, (Guides/Bridge/EveryBridge), I see links for source, broker, and trigger.
If I try to click on broker or trigger I am taken to this link https://knative.dev/docs/eventing/broker-trigger/ which shows a 404 page.
As a user, I would like all of the docs to have the same look and feel. Currently, depending on which dev created the docs, docs are not consistent. This can be difficult for users to know exactly where they can find the info they need.
We have created Target Templates and Examples. We will need all existing Targets to follow this style. You do not need to change screenshots of images, this is only to fix the formatting of text and location of text.
For example, we want an unordered list of the Prerequisites. If there is any test linking to what that prerequisite does or needs, we will need a separate section for that text.
Example:
Prerequisites
- AWS ARN
- AWS Credential
AWS ARN
This explains the foo bar baz biz
If you see spelling mistakes or grammar mistakes you may fix them in this issue.
If you would like to change the verbiage to something that makes more sense - go for it :)
ToDo
templates/target/targetExample.md
change Prerequisites
to Prerequisite(s)
templates/target/targetTemplate.md
change Prerequisites
to Prerequisite(s)
targets
and change the format to the templatecurrently the docs do not get automatically deployed.
I tried to install mkdocs based on the ReadMe. What I found was since I had python version 3 installed, the pip command did not work. It was pip3.
The datadog target was recently updated to use their native API instead of forwarding events through dogstatsd. As a result, the event type and payload has been altered to more accurately reflect what is expected by the Datadog API, however our docs have not been updated to keep in sync.
As a user, I would like all of the docs to have the same look and feel. Currently, depending on which dev created the docs, docs are not consistent. This can be difficult for users to know exactly where they can find the info they need.
We have created Source Templates and Examples. We will need all existing Sources to follow this style. You do not need to change screenshots of images, this is only to fix the formatting of text and location of text.
For example, we want an unordered list of the Prerequisites. If there is any test linking to what that prerequisite does or needs, we will need a separate section for that text.
Example:
Prerequisites
- AWS ARN
- AWS Credential
AWS ARN
This explains the foo bar baz biz
If you see spelling mistakes or grammar mistakes you may fix them in this issue.
If you would like to change verbiage to something that makes more sense - go for it :)
ToDo
templates/source/sourceExample.md
change Prerequisites
to Prerequisite(s)
templates/source/sourceTemplate.md
change Prerequisites
to Prerequisite(s)
sources
and change the format to the templateA declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.