Skip to content

Commit

Permalink
Issue #666: Add links to OpenShift documentation
Browse files Browse the repository at this point in the history
The OpenShift documentation is already fairly extensive, we can link
to it when needed to expand on our own documentation.

This fixes #666
  • Loading branch information
cfergeau authored and praveenkumar committed Oct 3, 2019
1 parent 96a6792 commit e7a5885
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This cluster provides a minimal environment for development and testing purposes
It's mainly targetted at running on developers' desktops.
For other use cases, such as headless, multi-developer/team-based setups, ..., use of the link:https://cloud.redhat.com/openshift/install/[full-fledged OpenShift installer] is recommended.

You can refer to the link:https://docs.openshift.com/container-platform/latest/welcome/index.html#developer-activities[OpenShift documentation] for a more in-depth introduction to OpenShift.

{prod} includes the [command]`{bin}` command-line interface (CLI) to interact with the {prod} virtual machine running the OpenShift cluster.

= Differences with a production OpenShift install
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ The cluster can initially be accessed through either the `kubeadmin` or `develop
For creating projects or OpenShift applications, and for application deployment, the `developer` user should be used.
The `kubeadmin` user should only be used for administrative tasks such as creating new users, setting roles, and so on.
====
+
. The link:https://docs.openshift.com/container-platform/latest/applications/projects/working-with-projects.html[OpenShift documentation] covers the creation of projects and applications.
+
See <<troubleshooting-codeready-containers_{context}>> if you cannot access the {prod} OpenShift cluster.

Expand Down Expand Up @@ -85,5 +87,7 @@ storage 4.1.0-rc.0 True False Fals
The `machine-config` and `marketplace` cluster operators are expected to report `False` availability.
The `monitoring` cluster operator is expected to report `Unknown` availability.
====
+
. The link:https://docs.openshift.com/container-platform/latest/applications/projects/working-with-projects.html[OpenShift documentation] covers the creation of projects and applications.
+
See <<troubleshooting-codeready-containers_{context}>> if you cannot access the {prod} OpenShift cluster.

0 comments on commit e7a5885

Please sign in to comment.