You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

The quick version: File a bug at https://issues.apache.org/jira/browse/CLOUDSTACK with the "Component" field set to Doc. Please check for duplicates first.

The longer version, with our hints for filing the most informative and easy-to-fix bug possible:

  1. Head to https://issues.apache.org/jira/browse/CLOUDSTACK. 
  2. If you don't have an account yet, click Sign Up. Once you have an account, log in.
  3. Click Issues - Search for Issues. In Project, choose CloudStack. Then click Refresh Search (it's in a blue box below the Issue Type field.) In Components, choose Doc. Now fill in some likely values in the other fields and click Search to see whether your bug has already been filed. If so, you're done! Otherwise, go on to the next step...
  4. Click Create Issue. In the popup, make sure the Project is CloudStack, then click Create.
  5. In Component, choose Doc. << This is the most important part.
  6. There are lots of other fields you could fill in, but we only need to talk about Summary and Description. 
  • In the Summary, please be specific. Example of uninformative summary: "Error in install guide." Example of excellent, if unlikely, summary: "Install guide incorrectly says user must remove hat before running cloud-setup-agent." 
  • In the Description, refer to the section heading, not the page number or section number ("Setting Up the Agent," not "3.2.1"). Those numbers change frequently.
  • Provide as much information as possible, including not just the problem but the solution, if you know it. For example, instead of "ls won't work for file size" it would be more helpful to say "to get the file size and other details, you have to use ls -l."

HELP MAKE THIS EASIER:Wish you could just pick a Doc Bug Template and have all this auto-filled for you? Vote for https://jira.atlassian.com/browse/JRA-7731.

  • No labels