[techdocs] Add TechDocs Plugin #213
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The TechDocs plugin can be used to display the documentation for your applications and services within kobs. For that you can write your documentation in the repository for each service and push any changes to the documentation to an storage like S3. kobs can then render your markdown files from a S3 bucket, so that you can access all of your documentation within one service. kobs also supports to embed your TechDocs into a dashboard. For that you can choose between the "list" and "toc" type for the TechDocs plugin. The "list" type is used to display all available TechDocs and the "toc" type to display the table of contents for a single service. Besides the normal markdown syntax, kobs also supports a specical code block language named "kobs", which can be used to display a panel from another plugin within your documentation.
ricoberger
force-pushed
the
add-techdocs-plugin
branch
from
242f4cf to
2fa748f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The TechDocs plugin can be used to display the documentation for your
applications and services within kobs. For that you can write your
documentation in the repository for each service and push any changes to
the documentation to an storage like S3. kobs can then render your
markdown files from a S3 bucket, so that you can access all of your
documentation within one service.
kobs also supports to embed your TechDocs into a dashboard. For that you
can choose between the "list" and "toc" type for the TechDocs plugin.
The "list" type is used to display all available TechDocs and the "toc"
type to display the table of contents for a single service.
Besides the normal markdown syntax, kobs also supports a specical code
block language named "kobs", which can be used to display a panel from
another plugin within your documentation.