Project

Profile

Help

Issue #840

Updated by bmbouter about 7 years ago

When users go to use an beta or a release candidate, there isn't a clear place to read the docs from. When we publish a beta or RC, we should include a link to the docs. This builder should also be used by QE for docs bug verification and reference to the docs for the release they are testing. 

 I'll suggest There are at least two ways to fix this: 

 (1) Make sure that we use Private builders. Private builders are not publicly shown, 'master' is being built, and link users and QE to that. This is easy, but master isn't exactly the version for the docs so its not completely correct. I do not recommend this approach. 

 (2) Create a 'Private' builder in RTD that isn't indexed by search engines because the link to them is hard to find. If or shown unless you specifically have the link you its link. Users and QE can view be linked to that. All we need to do is update the docs without any authentication. 

 Update the build docs so steps to include that when a beta or RC is published, published that the builder ensures a 'Private' builder for that -testing branch be enabled in RTD as 'Private'. If a release is enabled. Have being published, that builder build against the *-testing branch containing the beta or RC. Users and QE can should be linked set from 'Private' to that. 'Public' along with /latest/ being set to that branch. This also make going live with the docs easier. I recommend this approach.

Back