Skip to content

Commit 818041e

Browse files
authored
Merge pull request #79405 from ShaunaDiaz/OSDOCS-11452
OSDOCS-11452: refactor Getting started title MicroShift
2 parents 6663991 + 87b3442 commit 818041e

File tree

10 files changed

+48
-65
lines changed

10 files changed

+48
-65
lines changed

_attributes/attributes-microshift.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
:OCP: OpenShift Container Platform
77
:ocp-version: 4.17
88
:oc-first: pass:quotes[OpenShift CLI (`oc`)]
9+
//OpenShift Kubernetes Engine
10+
:oke: OpenShift Kubernetes Engine
911
:product-title-first: Red Hat build of MicroShift (MicroShift)
1012
:microshift-short: MicroShift
1113
:product-registry: OpenShift image registry

_topic_maps/_topic_map_ms.yml

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,29 +22,20 @@
2222
# topic groups and topics on the main page.
2323

2424
---
25-
Name: About
25+
Name: Understanding MicroShift
2626
Dir: microshift_welcome
2727
Distros: microshift
2828
Topics:
29-
- Name: Welcome
29+
- Name: Understanding Red Hat build of MicroShift
3030
File: index
3131
---
32-
Name: Release notes
32+
Name: Red Hat build of MicroShift release notes
3333
Dir: microshift_release_notes
3434
Distros: microshift
3535
Topics:
3636
- Name: Red Hat build of MicroShift 4.17 release notes
3737
File: microshift-4-17-release-notes
3838
---
39-
Name: Getting started
40-
Dir: microshift_getting_started
41-
Distros: microshift
42-
Topics:
43-
- Name: Understanding Red Hat build of MicroShift
44-
File: microshift-understanding
45-
- Name: Architecture
46-
File: microshift-architecture
47-
---
4839
Name: Installing
4940
Dir: microshift_install
5041
Distros: microshift

microshift_getting_started/_attributes

Lines changed: 0 additions & 1 deletion
This file was deleted.

microshift_getting_started/images

Lines changed: 0 additions & 1 deletion
This file was deleted.

microshift_getting_started/microshift-understanding.adoc

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

microshift_getting_started/modules

Lines changed: 0 additions & 1 deletion
This file was deleted.

microshift_getting_started/snippets

Lines changed: 0 additions & 1 deletion
This file was deleted.

microshift_welcome/index.adoc

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,56 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="microshift-welcome-index"]
3-
= {product-title} {product-version} Documentation
2+
[id="microshift-understanding"]
3+
= Understanding {product-title}
44
include::_attributes/attributes-microshift.adoc[]
5-
:context: microshift-welcome-index
5+
:context: microshift-understanding
6+
7+
toc::[]
68

79
[.lead]
10+
811
Welcome to the official {product-title} {product-version} documentation, where you can learn about {microshift-short} and start exploring its features.
912

13+
[id="microshift-product-documentation_{context}"]
14+
== {microshift-short} product documentation
15+
1016
To browse the {microshift-short} {product-version} documentation, use one of the following methods:
1117

1218
* Use the navigation bars and links to browse.
1319
* Select the task that interests you from the contents of this Welcome page.
1420

1521
To get started with {microshift-short}, use the following links:
1622

17-
* xref:../microshift_getting_started/microshift-understanding.adoc#microshift-understanding[Understanding {product-title}]
18-
* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}]
23+
//text is in main assembly for the sake of cross references
1924
* xref:../microshift_release_notes/microshift-4-17-release-notes.adoc#microshift-4-17-release-notes[{product-title} release notes]
25+
* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}]
2026

2127
For related information, use the following links:
2228

2329
* link:https://access.redhat.com/documentation/en-us/red_hat_device_edge/4/html/overview/device-edge-overview[Red Hat Device Edge overview]
2430
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/composing_installing_and_managing_rhel_for_edge_images/index[RHEL for Edge documentation]
25-
* link:https://docs.openshift.com/container-platform/latest/welcome/index.html[OpenShift Container Platform documentation]
31+
* link:https://docs.openshift.com/container-platform/latest/welcome/index.html[{OCP} documentation]
32+
33+
include::modules/microshift-about.adoc[leveloffset=+1]
34+
35+
include::modules/microshift-arch-design.adoc[leveloffset=+1]
36+
37+
[id="microshift-openshift-apis_{context}"]
38+
== {microshift-short} OpenShift APIs
39+
40+
In addition to standard Kubernetes APIs, {microshift-short} includes a small subset of the APIs supported by {OCP}.
41+
42+
[cols="1,1",options="header"]
43+
|===
44+
^| API ^| API group
45+
| xref:../microshift_rest_api/network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[Route]
46+
| route.openshift.io/v1
47+
| xref:../microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[SecurityContextConstraints]
48+
| security.openshift.io/v1
49+
|===
50+
51+
include::modules/microshift-k8s-apis.adoc[leveloffset=+1]
52+
53+
[role="_additional-resources"]
54+
.Additional resources
55+
* xref:../microshift_rest_api/index.adoc#api-index[API index]
56+
* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine[{oke}]

modules/microshift-about.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// microshift/understanding-microshift.adoc
44

5+
:_mod-docs-content-type: CONCEPT
56
[id="con-about-microshift_{context}"]
67
= About {product-title}
78

microshift_getting_started/microshift-architecture.adoc renamed to modules/microshift-arch-design.adoc

Lines changed: 5 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
1-
:_mod-docs-content-type: ASSEMBLY
2-
[id="microshift-architecture"]
3-
= Architecture
4-
include::_attributes/attributes-microshift.adoc[]
5-
include::_attributes/common-attributes.adoc[]
6-
:context: microshift-architecture
7-
8-
toc::[]
9-
10-
Learn the specifics of {product-title} architecture including design intent, how it differs from {oke}, and API compatibility.
1+
// Module included in the following assemblies:
2+
//
3+
// microshift/understanding-microshift.adoc
114

5+
:_mod-docs-content-type: CONCEPT
126
[id="microshift-architectural-design_{context}"]
137
== Architectural design
148
{microshift-short} is a single-node container orchestration runtime designed to extend the benefits of using containers for running applications to low-resource edge environments. Because {microshift-short} is primarily a platform for deploying applications, only the APIs and features essential to operating in edge and small form factor computing environments are included.
@@ -57,25 +51,4 @@ The figure "{product-title} differences from {oke}" shows that {oke} has the sam
5751
* Cloud Integration
5852
* Virtual Machines (VMs) through {VirtProductName}
5953

60-
In {oke} and other {OCP} deployments, all of the components from the operating system through the cluster capabilities work as one comprehensive unit, with full cluster services for a multi-node Kubernetes workload. With {microshift-short}, functions such as over-the-air-updates, monitoring, and logging, are performed by the operating system.
61-
62-
[id="microshift-openshift-apis_{context}"]
63-
== {microshift-short} OpenShift APIs
64-
65-
In addition to standard Kubernetes APIs, {microshift-short} includes a small subset of the APIs supported by {OCP}.
66-
67-
[cols="1,1",options="header"]
68-
|===
69-
^| API ^| API group
70-
| xref:../microshift_rest_api/network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[Route]
71-
| route.openshift.io/v1
72-
| xref:../microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[SecurityContextConstraints]
73-
| security.openshift.io/v1
74-
|===
75-
76-
include::modules/microshift-k8s-apis.adoc[leveloffset=+1]
77-
78-
[role="_additional-resources"]
79-
.Additional resources
80-
* xref:../microshift_rest_api/index.adoc#api-index[API index]
81-
* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine[{oke}]
54+
In {oke} and other {OCP} deployments, all of the components from the operating system through the cluster capabilities work as one comprehensive unit, with full cluster services for a multi-node Kubernetes workload. With {microshift-short}, functions such as over-the-air-updates, monitoring, and logging, are performed by the operating system.

0 commit comments

Comments
 (0)