what happened to the comment sections in the documentation pages?

Latest response

Being able to make comments visible on the documentation pages was invaluable. Where did it go? There are a lot of places where our documentation could be more accurate or complete and the comments allowed this to be mitigated immediately. Case in point: https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html/manual_installation_procedures/sect-tempest-configure:

This statement:
tools/config_tempest.py --debug --create identity.uri OS_AUTH_URLidentity.admin_username OS_USERNAME identity.admin_password OS_PASSWORD identity.admin_tenant_name OS_TENANT_NAME object-storage.operator_role Member

has a number of issues: it is missing a space after 'OS_AUTH_URL and the environment variables need a '$'. So it should be:

tools/config_tempest.py --debug --create identity.uri $OS_AUTH_URL identity.admin_username $OS_USERNAME identity.admin_password $OS_PASSWORD identity.admin_tenant_name $OS_TENANT_NAME object-storage.operator_role Member

I have no place to give that feedback now. I say bring back the comments!!!

Responses

Hi Christopher,

Comments on docs have been disabled because of some implementation problems. They will be re-enabled (or a similar feedback mechanism provided) as soon as the problems are resolved.

Comments are a very valuable feature for the documentation team, so we're eager to have them back as soon as possible.

In the meantime, I'm forwarding your feedback to the OpenStack docs people.

Hi Christopher, Robert told me about your suggestions towards the tempest procedure in Configure the Integration Test Suite chapter of the Manual Installation Procedures guide. I have created a bug report (https://bugzilla.redhat.com/show_bug.cgi?id=1425340) to fix the problem as soon as possible. You can follow the changes in Bugzilla.

I agree with Robert that comments (or any other form of easy feedback) is an important part of the documentation process.

Thank you very much for your help with reporting the problem.

The reported problems have been fixed (https://bugzilla.redhat.com/show_bug.cgi?id=1425340). Thanks once more for reporting it.

Close

Welcome! Check out the Getting Started with Red Hat page for quick tours and guides for common tasks.