-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Description
Most of the documentation is equivalent between OpenShift Origin and OpenShift Enterprise, but because the documentation pages look very similar, it can be difficult to determine whether the documentation you're reading is applicable to the product you're using.
For example, compare: https://docs.openshift.com/enterprise/latest/creating_images/guidelines.html and https://docs.openshift.org/latest/creating_images/guidelines.html
It would be nice to have some easy indication of the product to which the currently-viewed documentation applies, for example a banner notice at the top stating: "This documentation applies to OpenShift Origin. View the documentation for OpenShift Enterprise instead." - the cross-link is helpful particularly if you find the documentation via a search engine and want to make sure that everything in the document applies to your product. Unfortunately, there's also similar problems between versions of the same product as well (it's possible to be reading documentation for 3.2 only to find that the feature doesn't exist in 3.1, which is useful information though could be frustrating for users).
Other ideas might be:
- A drop-down link in place of the "OpenShift Origin Latest" text in the breadcrumb (this would require knowing whether a document of the same name exists in other products)
- More distinguished logos in the header (currently OpenShift Online and OpenShift Enterprise share the same logo)
- A built-in search function that users can use in place of Google, so that users can easily narrow down their searches to a single product
Unfortunately, this might be tricky to implement since each set of documentation may be built separately, making each build dependent on other builds :/