-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSDOCS-11452: refactor Getting started title MicroShift #79405
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
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -1,25 +1,56 @@ | ||
:_mod-docs-content-type: ASSEMBLY | ||
[id="microshift-welcome-index"] | ||
= {product-title} {product-version} Documentation | ||
[id="microshift-understanding"] | ||
= Understanding {product-title} | ||
include::_attributes/attributes-microshift.adoc[] | ||
:context: microshift-welcome-index | ||
:context: microshift-understanding | ||
|
||
toc::[] | ||
|
||
[.lead] | ||
|
||
Welcome to the official {product-title} {product-version} documentation, where you can learn about {microshift-short} and start exploring its features. | ||
|
||
[id="microshift-product-documentation_{context}"] | ||
== {microshift-short} product documentation | ||
|
||
To browse the {microshift-short} {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 {microshift-short}, 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}] | ||
//text is in main assembly for the sake of cross references | ||
* xref:../microshift_release_notes/microshift-4-17-release-notes.adoc#microshift-4-17-release-notes[{product-title} release notes] | ||
* xref:../microshift_install/microshift-install-rpm.adoc#microshift-install-rpm[Installing {product-title}] | ||
|
||
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] | ||
* link:https://docs.openshift.com/container-platform/latest/welcome/index.html[{OCP} documentation] | ||
|
||
include::modules/microshift-about.adoc[leveloffset=+1] | ||
|
||
include::modules/microshift-arch-design.adoc[leveloffset=+1] | ||
|
||
[id="microshift-openshift-apis_{context}"] | ||
== {microshift-short} OpenShift APIs | ||
|
||
In addition to standard Kubernetes APIs, {microshift-short} includes a small subset of the APIs supported by {OCP}. | ||
|
||
[cols="1,1",options="header"] | ||
|=== | ||
^| API ^| API group | ||
| xref:../microshift_rest_api/network_apis/route-route-openshift-io-v1.adoc#route-route-openshift-io-v1[Route] | ||
| route.openshift.io/v1 | ||
| xref:../microshift_rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc#securitycontextconstraints-security-openshift-io-v1[SecurityContextConstraints] | ||
| security.openshift.io/v1 | ||
|=== | ||
|
||
include::modules/microshift-k8s-apis.adoc[leveloffset=+1] | ||
|
||
[role="_additional-resources"] | ||
.Additional resources | ||
* xref:../microshift_rest_api/index.adoc#api-index[API index] | ||
* link:https://www.redhat.com/en/technologies/cloud-computing/openshift/kubernetes-engine[{oke}] |
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
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.