-
Bug
-
Resolution: Unresolved
-
None
-
None
-
Important
The docs team identified the following issues with the CDK pages on dev.rh.com:
https://developers.redhat.com/products/cdk/
Overview
- Links to the CDK Install. Guide point to 2.3 docs.
Hello World! - Linux
- Link to the CDK Install. Guide from the NOTICE box points to a 2.3 doc.
- The NOTICE box says "To use the latest release of OpenShift Container Platform 3.4 with the CDK", which doesn't make sense because 3.4 is included by default in CDK 2.4.
- The NOTICE box uses "the CDK". That's wrong – there should be no article.
- Step #2, section "Install Vagrant" links to a 2.3 doc.
- Step #2, section "Download the Container Development Environment" links to CDK 2.3 Vagrant box.
- Step #3 links to 2.2 and 2.3 docs.
Hello World! - macOS
- Same comments as above about the NOTICE box apply.
- The NOTICE box links to the CDK Install. Guide's section about installing RHEL, not macOS.
- Step #1 links to a 2.3 doc.
- Step #1, step #1: links to "devsuite-1.3.0-Alpha1-bundle-installer-mac.zip" and calls it "Red Hat Development Suite 1.2 macOS".
- Step #1, step #2: says to download "Java SE 1.8.0 Build 111", which is old.
- Step #1, step #7: screenshot shows CDK 2.3 and Java 1.8.0_111.
Hello World! - macOS
- Same comments as above about the NOTICE box apply.
- The NOTICE box links to the CDK Install. Guide's section about installing RHEL, not Windows.
- Step #1, step #1: says to download "Red Hat Development Suite 1.2 installer".
- Step #1, step #5: says "Open JDK" – correct is "OpenJDK".
- Step #1, step #5: screenshot shows CDK 2.2.
Docs and APIs
- All 'html' and 'html-single' links point to docs using the old URL format. Io have verified that redirects work well for these docs, but they should still be updated to the new format.
Help
- The page links to forum posts at https://developer.jboss.org/, but that page announces "PLEASE NOTE: Developing on Containers Q&A has moved to StackOverflow".
Resources
- Link to "Container Security Guide" is ionvalid, the correct link is: https://access.redhat.com/documentation/en/red-hat-enterprise-linux-atomic-host/7/paged/container-security-guide/
- I'd also consider updating all other documentation links to the new URL format (even though redirects work properly).
- Container image description "Ruby on Rails 4.1 platform for building and running applications" should be updated to say "4.2" (the image itself is correct).
- Container image description "Developer Toolset 6 toolchain (includes GCC 6, Eclipse, etc.)" is incorrect – there's no Eclipse in that image (nor is Eclipse a part of DTS for that matter).
- Container image description "MongoDB 3,.2 NoSQL database server" – remove the comma.