search

bloomreach / docs-feedback

1 stars 0 forks source link

content HAL api docs issue #15

Open joeyliechty opened 4 years ago

joeyliechty commented 4 years ago

https://documentation.bloomreach.com/13/library/enterprise/services-features/content-hal-api/install.html

This documentation links to https://documentation.bloomreach.com/library/enterprise/services-features/content-hal-api/release-notes.html which has the incorrect version numbers of the content hal API.

furthermore, this documentation: https://documentation.bloomreach.com/13/library/enterprise/services-features/translations-addon/release-notes.html claims that 3.x goes with release v12 - which directly contradicts the previous documentation link.

  1. the content-hal-api has no version greater than 3.1.1 at time of this feedback, but the docs claim it goes up to 4.x
  2. the documentation claims that for cms v14, 4.x should be used (it doesn't exist)
joeyliechty commented 4 years ago

instead of having a 'version-lookup-page', why not just specify the correct version in the install instructions documentation itself?

jeroenhoffman commented 4 years ago

which has the incorrect version numbers of the content hal API

I don't think there's anything wrong with the version numbers themselves. If you disagree, please be more detailed.

The release notes already state 4.0.0 is unreleased. It's now in the table as well.

The link below 3.x pointed to a wrong page, to one of a different plugin (translations addon). I fixed that.