From 05bb3df3072a0736003ce74f69f73ba3ec98b775 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CShauna=20Diaz=E2=80=9D?= Date: Tue, 11 Jul 2023 09:06:01 -0400 Subject: [PATCH] OSDOCS-6772-all: move welcome page microshift --- _topic_maps/_topic_map_ms.yml | 4 +--- microshift_welcome/_attributes | 1 + microshift_welcome/images | 1 + microshift_welcome/index.adoc | 25 +++++++++++++++++++++++++ microshift_welcome/modules | 1 + microshift_welcome/snippets | 1 + welcome/index.adoc | 22 +++------------------- 7 files changed, 33 insertions(+), 22 deletions(-) create mode 120000 microshift_welcome/_attributes create mode 120000 microshift_welcome/images create mode 100644 microshift_welcome/index.adoc create mode 120000 microshift_welcome/modules create mode 120000 microshift_welcome/snippets diff --git a/_topic_maps/_topic_map_ms.yml b/_topic_maps/_topic_map_ms.yml index 89ecb5beec..0cfca3bfa6 100644 --- a/_topic_maps/_topic_map_ms.yml +++ b/_topic_maps/_topic_map_ms.yml @@ -23,13 +23,11 @@ --- Name: About -Dir: welcome +Dir: microshift_welcome Distros: microshift Topics: - Name: Welcome File: index -- Name: Legal notice - File: legal-notice --- Name: Release notes Dir: microshift_release_notes diff --git a/microshift_welcome/_attributes b/microshift_welcome/_attributes new file mode 120000 index 0000000000..f27fd275ea --- /dev/null +++ b/microshift_welcome/_attributes @@ -0,0 +1 @@ +../_attributes/ \ No newline at end of file diff --git a/microshift_welcome/images b/microshift_welcome/images new file mode 120000 index 0000000000..e4c5bd02a1 --- /dev/null +++ b/microshift_welcome/images @@ -0,0 +1 @@ +../images/ \ No newline at end of file diff --git a/microshift_welcome/index.adoc b/microshift_welcome/index.adoc new file mode 100644 index 0000000000..1eb07ee57f --- /dev/null +++ b/microshift_welcome/index.adoc @@ -0,0 +1,25 @@ +:_content-type: ASSEMBLY +[id="microshift-welcome-index"] += {product-title} {product-version} Documentation +include::_attributes/attributes-microshift.adoc[] +:context: microshift-welcome-index + +[.lead] +Welcome to the official {product-title} {product-version} documentation, where you can learn about {product-title} and start exploring its features. + +To browse the {product-title} {product-version} documentation, use one of the following methods: + +* Use the navigation bars and links to browse. +* Select the task that interests you from the contents of this Welcome page. + +To get started with {product-title}, use the following links: + +* xref:../microshift_getting_started/microshift-understanding.adoc#microshift-understanding[Understanding {product-title}] +* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}] +* xref:../microshift_release_notes/microshift-4-14-release-notes.adoc#microshift-4-14-release-notes[{product-title} release notes] + +For related information, use the following links: + +* link:https://access.redhat.com/documentation/en-us/red_hat_device_edge/4/html/overview/device-edge-overview[Red Hat Device Edge overview] +* 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] +* link:https://docs.openshift.com/container-platform/latest/welcome/index.html[OpenShift Container Platform documentation] \ No newline at end of file diff --git a/microshift_welcome/modules b/microshift_welcome/modules new file mode 120000 index 0000000000..43aab75b53 --- /dev/null +++ b/microshift_welcome/modules @@ -0,0 +1 @@ +../modules/ \ No newline at end of file diff --git a/microshift_welcome/snippets b/microshift_welcome/snippets new file mode 120000 index 0000000000..9f5bc7e4dd --- /dev/null +++ b/microshift_welcome/snippets @@ -0,0 +1 @@ +../snippets \ No newline at end of file diff --git a/welcome/index.adoc b/welcome/index.adoc index 73caa1e7fb..0cf9672d48 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -23,19 +23,12 @@ endif::[] ifndef::openshift-rosa[] -ifndef::openshift-rosa,openshift-dedicated,openshift-dpu,microshift[] +ifndef::openshift-rosa,openshift-dedicated,openshift-dpu[] To navigate the {product-title} {product-version} documentation, you can use one of the following methods: * Use the left navigation bar to browse the documentation. * Select the task that interests you from the contents of this Welcome page. -endif::openshift-rosa,openshift-dedicated,openshift-dpu,microshift[] - -ifdef::microshift[] -To navigate the {product-title} {product-version} documentation, you can use one of the following methods: - -* Use the navigation bars and links to browse. -* Select the task that interests you from the contents of this Welcome page. -endif::microshift[] +endif::openshift-rosa,openshift-dedicated,openshift-dpu[] ifdef::openshift-dpu[] To navigate the {product-title} data processing unit (DPU) documentation, use the left navigation bar. @@ -49,15 +42,6 @@ To navigate the {product-title} documentation, use the left navigation bar. For documentation that is not specific to {product-title}, see the link:https://docs.openshift.com/container-platform/latest/welcome/index.html[OpenShift Container Platform documentation]. endif::[] -ifdef::microshift[] -Start with xref:../microshift_getting_started/microshift-understanding.adoc#microshift-understanding[Understanding {product-title}] and xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpm[Installing]. -Next, view the xref:../microshift_release_notes/microshift-4-14-release-notes.adoc#microshift-4-14-release-notes[release notes]. - -* For information about Red Hat Device Edge, read the link:https://access.redhat.com/documentation/en-us/red_hat_device_edge/4/html/overview/device-edge-overview[Red Hat Device Edge overview]. -* For information about Red Hat Enterprise Linux for Edge, read the 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]. -* For container platform documentation that is not specific to {product-title}, read the link:https://docs.openshift.com/container-platform/latest/welcome/index.html[OpenShift Container Platform documentation]. -endif::[] - ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] Start with xref:../architecture/architecture.adoc#architecture-overview-architecture[Architecture] and xref:../security/container_security/security-understanding.adoc#understanding-security[Security and compliance]. @@ -65,7 +49,6 @@ ifdef::openshift-enterprise,openshift-webscale[] Next, view the xref:../release_notes/ocp-4-14-release-notes.adoc#ocp-4-14-release-notes[release notes]. endif::[] -endif::[] ifdef::openshift-online,openshift-aro[] Start with **xref:../architecture/architecture.adoc#architecture-overview-architecture[Architecture]**. @@ -324,5 +307,6 @@ While cluster maintenance and host configuration is performed by the Red Hat Sit - *Monitor clusters*: Learn to use the Web UI to access monitoring dashboards. - *Manage nodes*: Learn to manage nodes, including configuring machine pools and autoscaling. endif::[] +endif::openshift-enterprise,openshift-webscale,openshift-origin[] endif::openshift-rosa[]