generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 52
RHDH-5561: TechDocs content restructure #877
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
:_mod-docs-content-type: CONCEPT | ||
|
||
[id="about-techdocs_{context}"] | ||
= About TechDocs | ||
|
||
The {product} instance comes with the TechDocs plugin preinstalled and enabled by default. Your organization can use the TechDocs plugin to create, find, and manage documentation in a central location and in a standardized way. You can also enhance your technical documentation experience with built-in TechDocs features and add-ons. For example: | ||
|
||
Docs-like-code approach:: | ||
Write your technical documentation in Markdown files that are stored inside your project repository along with your code. | ||
|
||
Documentation site generation:: | ||
Use MkDocs to create a full-featured, Markdown-based, static HTML site for your documentation that is rendered centrally in {product-short}. | ||
|
||
Documentation site metadata and integrations:: | ||
See additional metadata about the documentation site alongside the static documentation, such as the date of the last update, the site owner, top contributors, open GitHub issues, Slack support channels, and Stack Overflow Enterprise tags. | ||
|
||
Built-in navigation and search:: | ||
Locate the information that you need within a document quickly and easily. | ||
|
||
Add-ons:: | ||
Customize your TechDocs experience with add-ons to address higher-order documentation needs. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../artifacts |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../assemblies |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<title>TechDocs for {product}</title> | ||
<productname>{product}</productname> | ||
<productnumber>{product-version}</productnumber> | ||
<subtitle> | ||
</subtitle> | ||
<abstract> | ||
<para>Your organization can use the built-in TechDocs plugin for {product} to create, find, and use technical documentation in a central location and in a standardized way. Use supported TechDocs add-ons, or create your own, to further enhance your documentation experience.</para> | ||
</abstract> | ||
<authorgroup> | ||
<orgname>{company-name} Customer Content Services</orgname> | ||
</authorgroup> | ||
<xi:include href="Common_Content/Legal_Notice.xml" | ||
xmlns:xi="http://www.w3.org/2001/XInclude" /> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../images |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
[id="title-techdocs-rhdh"] | ||
include::artifacts/attributes.adoc[] | ||
= TechDocs for {product} | ||
linfraze marked this conversation as resolved.
Show resolved
Hide resolved
|
||
:context: title-techdocs-rhdh | ||
:imagesdir: images | ||
|
||
// about techdocs | ||
include::modules/techdocs/con-techdocs-about.adoc[leveloffset=+1] | ||
|
||
// techdocs configuration | ||
include::assemblies/assembly-configuring-techdocs.adoc[leveloffset=+1] | ||
|
||
// techdocs add-ons |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../modules |
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.
Uh oh!
There was an error while loading. Please reload this page.