Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Jclouds Wiki" for 
change notification.

The "How to Contribute Documentation" page has been changed by EverettToews:
https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation

New page:
Documentation got you down? You can fix it!

Contributing to the jclouds documentation site at jclouds.incubator.apache.org 
is easy and can be done entirely from within your web browser.

1. '''Find'''

Go to the 
[[https://github.com/jclouds/jclouds-site/tree/master/documentation|jclouds-site
 documentation]] and find the doc you want to change. The website directory 
structure mimics the GitHub site so files are easy to find. For example:

|| Website || http://jclouds.incubator.apache.org || 
/documentation/quickstart/chef/ ||
|| GitHub  || https://github.com/jclouds/jclouds-site/blob/master || 
/documentation/quickstart/chef.md ||

2. '''Edit'''

Click on the Edit button for that file. Make your edits and click on the 
Preview button to ensure nothing is obviously wrong. 

3. '''Commit'''

Below the editing window fill out the "Commit summary" field. If it's a big 
change, you can fill in the "Extended description". Click on Propose File 
Change (or Commit Changes if you're making an update).

On the next page follow the instructions to create a pull request.

4. '''Wait'''

At this point a documentation build has been kicked off in the background and 
you need to wait ~5 minutes for the result. During the wait, we encourage you 
to join the user mailing list: 
[[mailto:[email protected]|Subscribe]] 
([[http://www.mail-archive.com/[email protected]/|Archive]]) or 
the dev mailing list: [[mailto:[email protected]|Subscribe]] 
([[http://www.mail-archive.com/[email protected]/|Archive]]).

Eventually you should see a comment that reads.

{{{
jclouds-site-pull-requests #39 SUCCESS
This pull request looks good
}}}

Wait a bit longer for one more comment that reads.

{{{
Go to 
http://228e0faa97066fc327e5-07f246b6bd4e3aa7b5122e79013b6aae.r74.cf1.rackcdn.com/
}}}

If this link doesn't appear, please email the user or dev mailing lists.

Click on the link.

5. '''Review'''

The link will take you to a fully rendered version of the 
jclouds.incubator.apache.org site with your changes included. Review your 
changes to make sure everything looks the way you intended it.

A committer from jclouds will also be along to review your change. If 
everything looks good, they'll merge it for you. If they have some suggestions, 
you might have to go back and update.

5.1. '''Update'''

To update the file, you need to find it on the branch (e.g. patch-1) you 
initially created. For example:

https://github.com/your-user-name/jclouds-site/edit/patch-1/documentation/quickstart/chef.md
 

Go back to step 2.

6. '''Done'''

Congratulations. You've made a commit to Apache jclouds. Thanks!

Reply via email to