Give Simple Feedback

You can provide feedback about errors that are easy to fix, such as typographical errors, broken links, or simple grammar mistakes, using one of the following methods:

  • Use the Edit this page link in any web document
  • Post a comment on the Cumulus Forums
  • Post a message on Cumulus Community Slack channel

Details for each are included here. All are easy and quick, so choose the method that is most comfortable for you!

This method is convenient when you find an error as you are reading a document.

You must have a GitHub account to submit your suggestion. If you do not have a GitHub account, you can either create one or use one of the other feedback methods.

To submit your feedback with this method:

  1. Open the document in the Cumulus Docs site.

  2. Confirm you are displaying the document using one of the layouts with the right navigation column visible. If needed, select an appropriate layout.

  3. At the top of that column, click the Edit this page link. This takes you to the editor for that page on GitHub.

  4. Make your changes in the Edit file tab.

  5. Click the Preview changes tab to see what your changes will look like.

  6. When you are satisfied with your changes, scroll down until you see the Commit changes box.

  7. Type a summary (top field) and, optionally, a description (bottom field) of the changes you made.

  8. Select Create a new branch for this commit and start a pull request. and enter the name of your branch.

  9. Click Propose file change. This opens a new pull request (PR).

  10. Select stage from the base dropdown.

    Please do not open PRs against the master branch.

  11. Verify that all of your changes are included in the commit, then click Create pull request.

You’re done! You have now created a PR for the documentation team to review, and, if approved, they will publish your edits.

Post a Comment on Cumulus Forums

This method is convenient when you find an error as you are reading a document, but do not have a GitHub account.

To submit your feedback with this method:

  1. Access the Cumulus Forums in one of three ways:

    • Open the document in the Cumulus Docs site, then click the Cumulus Forums tab on the right side of the screen. This opens a pop-up dialog. Scroll to the bottom and click Ask a question.
    • Open the document in the Cumulus Docs site, then click Forums in the docs site header
    • Enter https://forums.cumulusnetworks.com/ into your web browser address field
  2. Click Ask your question near the top on the right.

  3. If you have a MyCumulus account, sign in with your credentials. Optionally, click Create an account to set up a new account, or click X to close the dialog.

  4. Fill out the Create new topic form, then click Create.

Post a Message on Slack

If you use Slack, you can post your comment on the Cumulus Community Slack channel.

To submit feedback using this method:

  1. Add the Cumulus Community Slack channel (cumulusnetworks.slack.com) if you have not already done so.

  2. Select the cumulus-content channel, then enter your comment in the message box. Add this channel if needed.

  3. Click Enter to post your comment.