Repositories for projects in the OSS suite refer to the suite release docs page in their README

cyberark / conjur-oss-suite-release

Under development - Latest stable releases of the Conjur OSS suite

Apache License 2.0

7 stars 2 forks source link

Repositories for projects in the OSS suite refer to the suite release docs page in their README #45

Closed izgeri closed 4 years ago

izgeri commented 4 years ago

AC:

[x] Define a boilerplate that can be added to the top of repo READMEs to refer to the suite release / documentation
[ ] Update repo READMEs for suite component repos to include this snippet early in the README

This should probably not be done until there is a suite release, but the boilerplate can be defined earlier.

izgeri commented 4 years ago

The list of suite release repos can be found here - every repo listed in the suite should have this heading at the top.

The URL that they will be pointing to is: https://docs.conjur.org/Latest/en/Content/ReleaseNotes/ConjurOSS-suite-RN.htm

Suggested boilerplate (@alexkalish please review):

Are you using this project with Conjur OSS? Then we strongly recommend choosing the version of this project to use from the latest Conjur OSS suite release. Conjur maintainers perform additional testing on the suite release versions to ensure compatibility. For any questions, please contact us on Discourse

Most projects have a "Usage" section in the README that would be an appropriate place to put this info.

boazmichaely commented 4 years ago

@izgeri I think it's good

izgeri commented 4 years ago

Noting here that @alexkalish suggested that for integrations, etc the Conjur version is fixed, and they should choose the latest suite release that matches their Conjur version.

I propose:

Are you using this project with Conjur OSS? Then we strongly recommend choosing the version of this project to use from the latest Conjur OSS suite release. Conjur maintainers perform additional testing on the suite release versions to ensure compatibility. When possible, upgrade your Conjur version to match the latest suite release; when using integrations, choose the latest suite release that matches your Conjur version. For any questions, please contact us on Discourse.

izgeri commented 4 years ago

@BradleyBoutcher this is ready to go with the language above ^ can you please plan to work on this next week?

izgeri commented 4 years ago

Thanks @BradleyBoutcher for wrapping this up!