Skip to content

Commit e2d5b19

Browse files
[release-1.8] RHIDP-8956: Created titles for the new Developer category (#1485)
* Added title - manage and consume techdocs * Minor changes * Add develop title 2 * Fixing minor issue * Minor fix * Fixing title-related issues * Minor changes with the structure * Removing redundant assembly * test * Removing additional header * Minor update * Fixing xref issue * Incorporated Heena's and Fabrice's comments * Typo --------- Co-authored-by: Priyanka Abel <[email protected]>
1 parent 4f0a906 commit e2d5b19

File tree

45 files changed

+216
-86
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+216
-86
lines changed

assemblies/assembly-bulk-importing-from-github.adoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,6 @@ include::{docdir}/artifacts/snip-technology-preview.adoc[]
77

88
{product} can automate GitHub repositories onboarding and track their import status.
99

10-
include::modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc[leveloffset=+1]
11-
12-
include::modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc[leveloffset=+1]
13-
14-
include::modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc[leveloffset=+1]
15-
16-
include::modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc[leveloffset=+1]
17-
1810
include::modules/importing-repositories/concept-bulk-import-scaffolder-template.adoc[leveloffset=+1]
1911

2012
include::modules/importing-repositories/procedure-integrating-bulk-import-with-orchestrator-workflows.adoc[leveloffset=+1]
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
:context: about-software-catalogs
2+
:context: centralizing-your-software-components-in-rhdh
33

44
[id="{context}"]
5-
= About Software Catalogs
5+
= Centralizing your software components in the {product} catalog for easier access
66

77
The {product} Software Catalog is a centralized system that gives you visibility into all the software across your ecosystem, including services, websites, libraries, and data pipelines. You can use it to view ownership details and metadata for each component in one place.
88

@@ -16,18 +16,18 @@ The *Overview* page for a component provides key information such as links to th
1616

1717
//[Add any Component screenshot of the latest build]
1818

19-
include::modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc[leveloffset=+1]
19+
include::modules/centralizing-your-software-components-in-rhdh/proc-adding-new-components-to-the-rhdh-instance.adoc[leveloffset=+1]
2020

21-
include::modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc[leveloffset=+2]
21+
include::modules/centralizing-your-software-components-in-rhdh/proc-creating-new-components-in-the-rhdh-instance.adoc[leveloffset=+2]
2222

23-
include::modules/software-catalogs/proc-registering-components-manually-in-the-rhdh-instance.adoc[leveloffset=+2]
23+
include::modules/centralizing-your-software-components-in-rhdh/proc-registering-components-manually-in-the-rhdh-instance.adoc[leveloffset=+2]
2424

25-
include::modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc[leveloffset=+1]
25+
include::modules/centralizing-your-software-components-in-rhdh/proc-updating-existing-components-in-your-rhdh-catalog.adoc[leveloffset=+1]
2626

27-
include::modules/software-catalogs/proc-searching-and-filtering-software-catalog-items-by-kind.adoc[leveloffset=+1]
27+
include::modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-kind.adoc[leveloffset=+1]
2828

29-
include::modules/software-catalogs/proc-searching-and-filtering-software-catalog-items-by-using-the-filter-field.adoc[leveloffset=+1]
29+
include::modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-using-the-filter-field.adoc[leveloffset=+1]
3030

31-
include::modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc[leveloffset=+1]
31+
include::modules/centralizing-your-software-components-in-rhdh/proc-reviewing-the-yaml-configuration-of-your-rhdh-software-catalog.adoc[leveloffset=+1]
3232

33-
include::modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc[leveloffset=+1]
33+
include::modules/centralizing-your-software-components-in-rhdh/proc-starring-key-components-in-the-software-catalog.adoc[leveloffset=+1]

assemblies/assembly-configuring-templates.adoc

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,6 @@
77
Software Templates in {product} provide a streamlined way to create software components and publish them to different version control repositories such as Git.
88
Platform engineers create and maintain Software Templates in {product}.
99

10-
You can configure Software Templates to create software components, and publish these components to Git repositories.
11-
Once the components are published to Git repositories, register these components in the Software Catalog.
12-
13-
A template is a form composed of different UI fields that is defined in a YAML file.
14-
Software Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally.
15-
16-
include::modules/customizing-templates/proc-creating-templates.adoc[leveloffset=+1]
17-
include::modules/customizing-templates/ref-creating-templates.adoc[leveloffset=+1]
18-
include::modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc[leveloffset=+1]
19-
include::modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc[leveloffset=+1]
20-
include::modules/customizing-templates/proc-adding-templates.adoc[leveloffset=+1]
2110
include::modules/customizing-templates/proc-versioning-software-templates.adoc[leveloffset=+1]
2211
include::modules/customizing-templates/proc-enabling-software-template-version-update-notifications.adoc[leveloffset=+1]
2312
include::assembly-tracking-component-origin-and-software-template-version.adoc[leveloffset=+1]
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: importing-and-using-an-existing-template-for-faster-development
3+
4+
[id="{context}"]
5+
= Importing and using an existing Software Template for faster development
6+
7+
You can configure Software Templates to create software components and publish these components to Git repositories.
8+
Once the components are published to Git repositories, register these components in the Software Catalog.
9+
10+
A template is a form composed of different UI fields that is defined in a YAML file.
11+
Software Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally.
12+
13+
include::modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-templates.adoc[leveloffset=+1]
14+
15+
include::modules/importing-and-using-an-existing-template-for-faster-development/ref-creating-templates.adoc[leveloffset=+1]
16+
17+
include::modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-new-software-component-using-templates.adoc[leveloffset=+1]
18+
19+
include::modules/importing-and-using-an-existing-template-for-faster-development/proc-searching-and-filtering-software-templates.adoc[leveloffset=+1]
20+
21+
include::modules/importing-and-using-an-existing-template-for-faster-development/proc-adding-templates.adoc[leveloffset=+1]
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="importing-your-team-codebase-from-git"]
4+
= Importing your team's codebase from Git
5+
6+
include::{docdir}/artifacts/snip-technology-preview.adoc[]
7+
8+
{product} can automate GitHub repositories onboarding and track their import status.
9+
10+
include::modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc[leveloffset=+1]
11+
12+
include::modules/streamline-software-development-and-management/proc-importing-multiple-repositories-from-github.adoc[leveloffset=+1]
13+
14+
include::modules/streamline-software-development-and-management/proc-managing-repositories-after-import-to-stay-organized.adoc[leveloffset=+1]
15+
16+
include::modules/streamline-software-development-and-management/proc-monitoring-bulk-import-actions-using-audit-logs.adoc[leveloffset=+1]
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: assembly-manage-and-consume-techdoc-within-rhdh
3+
4+
[id="{context}"]
5+
= Manage and consume technical documentation within {product}
6+
7+
The TechDocs plugin is installed and enabled on your {product} instance by default. After an administrator configures the TechDocs plugin, an authorized developer can use the TechDocs plugin to add, view, or manage documentation.
8+
9+
include::assembly-techdocs-add-docs.adoc[leveloffset=+1]
10+
11+
include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-find-docs.adoc[leveloffset=+1]
12+
13+
include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-view-docs.adoc[leveloffset=+1]
14+
15+
include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-edit-docs.adoc[leveloffset=+1]
16+
17+
//embedding videos
18+
include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-embed-videos.adoc[leveloffset=+1]
19+
20+
//generating pipelines with GitHub Actions
21+
include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-pipeline-github-actions.adoc[leveloffset=+1]

assemblies/assembly-techdocs-add-docs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
:context: assembly-techdocs-add-docs
33

44
[id="{context}"]
5-
= Adding documentation to TechDocs
5+
= Adding documentation to TechDocs for your project
66

77
After an administrator configures the TechDocs plugin, a developer can add documentation to TechDocs by importing it from a remote repository. Any authorized user or group can access the documentation that is imported into the TechDocs plugin.
88

assemblies/assembly-using-techdocs.adoc

Lines changed: 0 additions & 21 deletions
This file was deleted.

modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc renamed to modules/centralizing-your-software-components-in-rhdh/proc-adding-new-components-to-the-rhdh-instance.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:_mod-docs-content-type: PROCEDURE
22

33
[id="proc-adding-new-components-to-the-rhdh-instance_{context}"]
4-
= Adding new components to your {product} instance
4+
= Adding new components to your {product} instance to expand your catalog
55

66
.Prerequisites
77

0 commit comments

Comments
 (0)