Skip to content

Commit 2727c1c

Browse files
themr0cthemr0c
authored
Merge branch 'main' into add-codeowners
2 parents f8314bf + fa54f2e commit 2727c1c

File tree

134 files changed

+2360
-1512
lines changed

Some content is hidden

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

134 files changed

+2360
-1512
lines changed

‎.asciidoctorconfig‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ include::{asciidoctorconfigdir}/artifacts/attributes.adoc[]
99
:chapter-signifier: Chapter
1010
:docinfo: shared
1111
:docinfodir: {asciidoctorconfigdir}/.asciidoctor
12-
:doctype: book
1312
:sectnumlevels: 5
1413
:sectnums:
1514
:source-highlighter: coderay

‎.github/pull_request_template.md‎

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,7 @@
66

77
**Version(s):**
88
<!--- Specify the version(s) of RHDH that your PR applies to. -->
9-
9+
Add the relevant labels to the Pull Request.
1010
**Issue:**
11-
<!--- Add a link to the Bugzilla, Jira, or GitHub issue. --->
12-
13-
**Link to docs preview:**
14-
<!--- Add direct link(s) to the exact page(s) that contain the updated content from the preview build. --->
15-
16-
**Reviews:**
17-
- [ ] SME: @ mention assignee
18-
- [ ] QE: @ mention assignee
19-
- [ ] Docs review: @ mention assignee
20-
- [ ] Additional review: @mention assignee (by writer)
21-
<!--- SME approval is required to merge a PR unless the changes are made by a subject matter expert. --->
22-
<!--- QE approval is required to merge a PR unless there are no technical changes to the content. --->
23-
<!--- Docs team approval is required for ALL PRs. --->
24-
25-
**Additional information:**
26-
<!--- Optional: Include additional context or expand the description here.--->
11+
<!--- Add a link to the Jira issue. --->
2712

28-
<!--- After you open your PR, request reviews from all required stakeholders via Slack GitHub, or Jira. --->

‎artifacts/attributes.adoc‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
:product: Red Hat Developer Hub
1111
:product-short: Developer Hub
1212
:product-very-short: RHDH
13-
:product-version: 1.3
14-
:product-bundle-version: 1.3.0
15-
:product-chart-version: 1.3.0
13+
:product-version: 1.4
14+
:product-bundle-version: 1.4.0
15+
:product-chart-version: 1.4.0
1616
:product-backstage-version: 1.29.2
1717
:rhdeveloper-name: Red Hat Developer
1818
:rhel: Red Hat Enterprise Linux
@@ -26,9 +26,11 @@
2626
:ocp-very-short: RHOCP
2727
:osd-brand-name: Red Hat OpenShift Dedicated
2828
:osd-short: OpenShift Dedicated
29+
:logging-brand-name: Red Hat OpenShift Logging
30+
:logging-short: OpenShift Logging
2931
// minimum and current latest supported versions
3032
:ocp-version-min: 4.14
31-
:ocp-version: 4.16
33+
:ocp-version: 4.17
3234
// First mention of OpenShift CLI or `oc` in a module
3335
:openshift-cli: pass:quotes[OpenShift CLI (`oc`)]
3436
:rhsso-brand-name: Red Hat Single-Sign On
@@ -86,9 +88,15 @@
8688
:authorization-book-url: https://docs.redhat.com/documentation/en-us/red_hat_developer_hub/{product-version}/html-single/authorization/index
8789
:authorization-book-title: Authorization
8890

91+
:installing-on-osd-on-gcp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_dedicated_on_google_cloud_platform/index
92+
:installing-on-osd-on-gcp-book-title: Installing {product} on {gcp-brand-name} on {gcp-brand-name}
93+
8994
:installing-on-ocp-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_openshift_container_platform/index
9095
:installing-on-ocp-book-title: Installing {product} on {ocp-short}
9196

97+
:installing-on-gke-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_google_kubernetes_engine/index
98+
:installing-on-gke-book-title: Installing {product} on {gke-brand-name}
99+
92100
:installing-on-eks-book-url: https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_red_hat_developer_hub_on_amazon_elastic_kubernetes_service/index
93101
:installing-on-eks-book-title: Installing {product} on {eks-brand-name}
94102

‎assemblies/assembly-about-rhdh.adoc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
ifdef::context[:parent-context-of-about-rhdh: {context}]
2+
3+
:_mod-docs-content-type: ASSEMBLY
4+
5+
ifndef::context[]
6+
[id="about-rhdh"]
7+
endif::[]
8+
ifdef::context[]
9+
[id="about-rhdh_{context}"]
10+
endif::[]
11+
= About {product}
12+
13+
:context: about-rhdh
14+
15+
{product} is a fully supported, open developer platform that reduces friction and frustration of developers while boosting productivity.
16+
17+
This platform is driven by a centralized software catalog, providing efficiency to your microservices and infrastructure.
18+
19+
Use {product} to simplify decision-making through a selection of internally approved tools, programming languages, and developer resources within a self-managed portal.
20+
21+
22+
include::modules/about/con-benefits-of-rhdh.adoc[leveloffset=+1]
23+
include::modules/about/ref-supported-platforms.adoc[leveloffset=+1]
24+
include::modules/about/ref-rhdh-sizing.adoc[leveloffset=+1]
25+
include::modules/about/ref-customer-support-info.adoc[leveloffset=+1]

‎assemblies/assembly-audit-log.adoc‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,16 @@ Audit logs are not forwarded to the internal log store by default because this d
3333
* For a complete list of fields that a {product-short} audit log can include, see xref:ref-audit-log-fields.adoc_{context}[]
3434
* For a list of scaffolder events that a {product-short} audit log can include, see xref:ref-audit-log-scaffolder-events.adoc_{context}[]
3535

36-
include::modules/getting-started/con-audit-log-config.adoc[leveloffset=+1]
36+
include::modules/observe/con-audit-log-config.adoc[]
3737

38-
include::modules/getting-started/proc-audit-log-view.adoc[leveloffset=+1]
38+
include::modules/observe/proc-forward-audit-log-splunk.adoc[leveloffset=+2]
3939

40-
include::modules/getting-started/ref-audit-log-fields.adoc[leveloffset=+2]
40+
include::modules/observe/proc-audit-log-view.adoc[]
4141

42-
include::modules/getting-started/ref-audit-log-scaffolder-events.adoc[leveloffset=+2]
42+
include::modules/observe/ref-audit-log-fields.adoc[leveloffset=+2]
4343

44-
include::modules/getting-started/ref-audit-log-catalog-events.adoc[leveloffset=+2]
44+
include::modules/observe/ref-audit-log-scaffolder-events.adoc[leveloffset=+2]
4545

46-
include::modules/getting-started/ref-audit-log-file-rotation-overview.adoc[leveloffset=+1]
46+
include::modules/observe/ref-audit-log-catalog-events.adoc[leveloffset=+2]
47+
48+
include::modules/observe/ref-audit-log-file-rotation-overview.adoc[]

‎assemblies/assembly-configuring-authorization-in-rhdh.adoc‎

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,32 @@ the {product-short} RBAC feature allows you
1616
to define policies in a declarative fashion using a simple CSV based format.
1717
You can define the policies by using {product-short} web interface or REST API, rather than editing the CSV directly.
1818

19-
To apply RBAC in {product-short}:
19+
To define authorizations in {product-short}:
2020

21-
. The {product-short} administrator sets up the RBAC feature:
22-
.. Enable the RBAC feature
23-
.. Configure Policy Administrators
21+
. The {product-short} administrator enables and gives access to the RBAC feature.
2422

25-
. The {product-short} policy administrator configures your RBAC policies:
26-
.. Define roles with specific permissions
27-
.. Assign the roles to users and groups
23+
. You define your roles and policies by combining the following methods:
2824

25+
* The {product-short} policy administrator uses the {product-short} web interface or REST API.
26+
* The {product-short} administrator edits the main {product-short} configuration file.
27+
* The {product-short} administrator edits external files.
2928

3029
include::modules/authorization/proc-enabling-the-rbac-plugin.adoc[leveloffset=+1]
3130

3231

33-
include::assembly-managing-authorizations-by-using-the-rhdh-web-ui.adoc[leveloffset=+1]
32+
include::modules/authorization/proc-determining-permission-policy-and-role-configuration-source.adoc[leveloffset=+1]
3433

3534

36-
include::modules/authorization/ref-rbac-permission-policies.adoc[leveloffset=+1]
35+
include::assembly-managing-authorizations-by-using-the-rhdh-web-ui.adoc[leveloffset=+1]
3736

3837

39-
include::modules/authorization/con-rbac-config-permission-policies.adoc[leveloffset=+2]
38+
include::assembly-managing-authorizations-by-using-the-rest-api.adoc[leveloffset=+1]
4039

4140

42-
include::modules/authorization/con-rbac-config-permission-policies-external-file.adoc[leveloffset=+3]
41+
include::assembly-managing-authorizations-by-using-external-files.adoc[leveloffset=+1]
4342

44-
include::modules/authorization/proc-mounting-the-policy-csv-file-using-the-operator.adoc[leveloffset=+4]
4543

46-
include::modules/authorization/proc-mounting-the-policy-csv-file-using-helm.adoc[leveloffset=+4]
44+
include::modules/authorization/ref-rbac-permission-policies.adoc[leveloffset=+1]
4745

4846

4947
include::modules/authorization/con-rbac-conditional-policies-rhdh.adoc[leveloffset=+1]
@@ -52,20 +50,8 @@ include::modules/authorization/con-rbac-conditional-policies-rhdh.adoc[leveloffs
5250
include::modules/authorization/ref-rbac-conditional-policy-definition.adoc[leveloffset=+2]
5351

5452

55-
include::modules/authorization/proc-rbac-config-conditional-policy-file.adoc[leveloffset=+2]
56-
57-
58-
5953
include::modules/authorization/con-user-stats-rhdh.adoc[leveloffset=+1]
6054

6155

6256
include::modules/authorization/proc-download-user-stats-rhdh.adoc[leveloffset=+2]
6357

64-
65-
include::modules/authorization/con-rbac-rest-api.adoc[leveloffset=+1]
66-
67-
68-
include::modules/authorization/proc-rbac-send-request-rbac-rest-api.adoc[leveloffset=+2]
69-
70-
71-
include::modules/authorization/ref-rbac-rest-api-endpoints.adoc[leveloffset=+2]

‎assemblies/assembly-configuring-external-postgresql-databases.adoc‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ As an administrator, you can configure and use external PostgreSQL databases in
55

66
[NOTE]
77
====
8-
{product-short} supports only configuring external PostgreSQL databases. You can perform maintenance activities, such as backing up your data or configuring high availability (HA) for the external PostgreSQL databases.
8+
{product-short} supports the configuration of external PostgreSQL databases. You can perform maintenance activities, such as backing up your data or configuring high availability (HA) for the external PostgreSQL databases.
99
10-
Also, configuring an external PostgreSQL instance by using the {product} Operator or Helm Chart is not intended for production use.
10+
By default, the {product} operator or Helm Chart creates a local PostgreSQL database. However, this configuration is not suitable for the production environments. For production deployments, disable the creation of local database and configure {product-short} to connect to an external PostgreSQL instance instead.
1111
====
1212

1313

@@ -17,5 +17,3 @@ include::modules/admin/proc-configuring-postgresql-instance-using-helm.adoc[leve
1717

1818
include::modules/admin/proc-migrating-databases-to-an-external-server.adoc[leveloffset=+1]
1919

20-
21-

‎assemblies/assembly-customizing-the-quick-access-card-in-rhdh.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="customizing-the-quick-access-card-in-rhdh"]
4+
= Customizing the Quick access card in {product}
5+
6+
To access the Home page in {product}, the base URL must include the `/developer-hub` proxy. You can configure the Home page by passing the data into the `app-config.yaml` file as a proxy. You can provide data to the Home page from the following sources:
7+
8+
* JSON files hosted on GitHub or GitLab.
9+
* A dedicated service that provides the Home page data in JSON format using an API.
10+
11+
include::modules/getting-started/proc-using-hosted-json-files-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1]
12+
include::modules/getting-started/proc-using-a-dedicated-service-to-provide-data-to-the-quick-access-card.adoc[leveloffset=+1]
13+
14+
15+

‎assemblies/assembly-customizing-the-rhdh-homepage.adoc‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[id='proc-customize-rhdh-homepage_{context}']
2+
= Customizing the Home page in {product}
3+
4+
When using the `app-config`, you can do the following:
5+
6+
* Customize and extend the default Home page layout with additional cards that appear based on the plugins you have installed and enabled.
7+
* Change quick access links.
8+
* Add, reorganize, and remove the following available cards:
9+
+
10+
** Search bar
11+
** Quick access
12+
** Headline
13+
** Markdown
14+
** Placeholder
15+
** Catalog starred entities
16+
** Featured docs
17+
18+
include::modules/getting-started/proc-customizing-the-home-page-cards.adoc[leveloffset=+1]
19+
include::modules/getting-started/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]

‎assemblies/assembly-managing-authorizations-by-using-external-files.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[id='managing-authorizations-by-using-external-files']
2+
= Managing authorizations by using external files
3+
4+
To automate {product} maintenance, you can configure permissions and roles in external files, before starting {product-short}.
5+
6+
7+
include::modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc[leveloffset=+1]
8+
9+
include::modules/authorization/proc-defining-authorizations-in-external-files-by-using-helm.adoc[leveloffset=+1]
10+

0 commit comments

Comments
 (0)