Skip to content

feedback.md

Latest commit

 

History

History
70 lines (47 loc) · 4.11 KB

feedback.md

File metadata and controls

70 lines (47 loc) · 4.11 KB
copyright
years
2018
lastupdated 2018-09-04

{:shortdesc: .shortdesc} {:tip: .tip} {:new_window: target="_blank"}

Submitting feedback

{: #feedback}

We want to hear from you! You can submit feedback for the {{site.data.keyword.Bluemix_notm}} team on the documentation or the console. You can use a few different methods to provide feedback:

  • Use the Feedback button to provide a comment about a specific page of documentation or area of the console user interface that you particularly like or are having trouble with.
  • Use the Edit in GitHub link at the top of any documentation page to provide a suggested edit for the content by using the GitHub pull request method.
  • Open an issue in GitHub for documentation to be updated or improved by providing a comment or request for clarification on a specific subject.
  • Submit an idea for improving the product or a specific service in the {{site.data.keyword.Bluemix_notm}} ideas portal.

Submitting a comment with the feedback button

When you are reading a page of documentation or completing a task within the console, you can find a feedback button on the edge of the page. Click the Feedback button to submit a rave review, a suggestion, or identify an error.

  1. Click Feedback.
  2. Select to provide Generic feedback for the entire page or product, or Specific feedback on a certain part of the page you are currently on.
  3. Select an option for what you think about the page or selection.
  4. Enter a short subject line about your feedback and a longer description about what you want to share with the {{site.data.keyword.Bluemix_notm}} team.
  5. Then, leave your email address if you want to receive progress from the team addressing the feedback that you submitted.

Common ad blockers block Usabilla and hide the Feedback button. Disable any ad blockers to use the Feedback button to submit your comments. {: tip}

Providing a content update with a pull request

You can submit suggested changes to any documentation page by using the Edit in GitHub link at the top of each page. By following that link and editing the page, you can submit updates in a pull request for the content team to review and merge.

Complete the following process to submit a pull request to the content team:

  1. Click Edit in Github on the page that you want to update.
  2. Click the Edit this file icon.
  3. Make the changes to the file in the WYSIWYG editor.
  4. Scroll to the end of the page and enter a brief description about your change. The extended description is optional.
  5. Select Propose file change.
  6. Select Create pull request.
  7. Review your changes for the pull request.
  8. Select Create pull request.

Opening an issue for the documentation

You can open an issue for the content team to address from any documentation page. Within your issue, provide the details about the improvement that you'd like to see. For example, you might state the steps on the page didn't match the user interface as you tried to complete the procedure, and you think the content needs to be updated, or you wanted to see additional information on a specific subject in that section.

To open an issue from a documentation page, complete the following steps:

  1. Click the Edit in GitHub link.
  2. Select Issues
  3. Click New issue.
  4. Enter a title and description for the issue.
  5. Click Submit new issue.

The content team receives the issues that you open and works to address the feedback. You can monitor the issue by saving the link after you click Submit new issue. As the issue gets resolved, the content team provides status updates as a comment on the issue.

Submitting ideas for product improvements

{: #ideas}

To submit ideas for {{site.data.keyword.Bluemix_notm}} and services improvements, go to IBM Cloud Ideas External link icon{: new_window}. For more information on how to use the idea portal, see Think, write, submit: New ideas portal for IBM Cloud External link icon{: new_window}.